mirror of
https://github.com/JanDeDobbeleer/oh-my-posh.git
synced 2025-03-05 20:49:04 -08:00
chore: add markdown linting
This commit is contained in:
parent
0a9343931b
commit
02f1c776dd
15
.github/workflows/markdown.yml
vendored
Normal file
15
.github/workflows/markdown.yml
vendored
Normal file
|
@ -0,0 +1,15 @@
|
||||||
|
name: Markdownlint
|
||||||
|
|
||||||
|
on: [pull_request]
|
||||||
|
|
||||||
|
jobs:
|
||||||
|
lint:
|
||||||
|
runs-on: ubuntu-latest
|
||||||
|
steps:
|
||||||
|
- name: Checkout code
|
||||||
|
uses: actions/checkout@v2
|
||||||
|
- name: Lint files
|
||||||
|
uses: nosborn/github-action-markdown-cli@v1.1.1
|
||||||
|
with:
|
||||||
|
files: .
|
||||||
|
config_file: "docs/.markdownlint.json"
|
12
README.md
12
README.md
|
@ -5,7 +5,9 @@
|
||||||
[![PS Gallery][psgallery-badge]][powershell-gallery]
|
[![PS Gallery][psgallery-badge]][powershell-gallery]
|
||||||
[![Documentation][docs-badge]][docs]
|
[![Documentation][docs-badge]][docs]
|
||||||
|
|
||||||
What started as the offspring of [oh-my-posh][oh-my-posh] for PowerShell resulted in a cross platform, highly customizable and extensible prompt theme engine. After 4 years of working on oh-my-posh, a modern and more efficient tool was needed to suit my personal needs.
|
What started as the offspring of [oh-my-posh][oh-my-posh] for PowerShell resulted in a cross platform,
|
||||||
|
highly customizable and extensible prompt theme engine. After 4 years of working on oh-my-posh,
|
||||||
|
a modern and more efficient tool was needed to suit my personal needs.
|
||||||
|
|
||||||
## ❤ Support ❤
|
## ❤ Support ❤
|
||||||
|
|
||||||
|
@ -36,15 +38,17 @@ What started as the offspring of [oh-my-posh][oh-my-posh] for PowerShell resulte
|
||||||
* [x] Create documentation on the different segments
|
* [x] Create documentation on the different segments
|
||||||
* Create easy installation packages
|
* Create easy installation packages
|
||||||
* [x] Powershell
|
* [x] Powershell
|
||||||
* [ ] Brew
|
* [x] Brew
|
||||||
* [ ] Chocolatey
|
* [x] Scoop
|
||||||
|
* [ ] Swap V2 with V3
|
||||||
|
|
||||||
## Thanks
|
## Thanks
|
||||||
|
|
||||||
* [Chris Benti][chrisbenti-psconfig] for providing the first influence to start oh-my-posh
|
* [Chris Benti][chrisbenti-psconfig] for providing the first influence to start oh-my-posh
|
||||||
* [Keith Dahlby][keithdahlby-poshgit] for creating posh-git and making life more enjoyable
|
* [Keith Dahlby][keithdahlby-poshgit] for creating posh-git and making life more enjoyable
|
||||||
* [Robby Russel][oh-my-zsh] for creating oh-my-zsh, without him this would probably not be here
|
* [Robby Russel][oh-my-zsh] for creating oh-my-zsh, without him this would probably not be here
|
||||||
* [Janne Mareike Koschinski][justjanne] for providing information on how to get certain information using Go (and the amazing [README][powerline-go])
|
* [Janne Mareike Koschinski][justjanne] for providing information on how to get certain information
|
||||||
|
using Go (and the amazing [README][powerline-go])
|
||||||
|
|
||||||
[release-status]: https://github.com/jandedobbeleer/oh-my-posh3/workflows/Release/badge.svg
|
[release-status]: https://github.com/jandedobbeleer/oh-my-posh3/workflows/Release/badge.svg
|
||||||
[psgallery-badge]: https://img.shields.io/powershellgallery/dt/oh-my-posh.svg
|
[psgallery-badge]: https://img.shields.io/powershellgallery/dt/oh-my-posh.svg
|
||||||
|
|
|
@ -33,7 +33,8 @@ Display the current path.
|
||||||
- folder_icon: `string` - the icon to use as a folder indication - defaults to `..`
|
- folder_icon: `string` - the icon to use as a folder indication - defaults to `..`
|
||||||
- windows_registry_icon: `string` - the icon to display when in the Windows registry - defaults to `\uE0B1`
|
- windows_registry_icon: `string` - the icon to display when in the Windows registry - defaults to `\uE0B1`
|
||||||
- style: `enum` - how to display the current path
|
- style: `enum` - how to display the current path
|
||||||
- mapped_locations: `map[string]string` - custom glyph/text for specific paths(only when `style` is set to `agnoster`, `agnoster_full` or `short`)
|
- mapped_locations: `map[string]string` - custom glyph/text for specific paths(only when `style` is set to `agnoster`,
|
||||||
|
`agnoster_full` or `short`)
|
||||||
|
|
||||||
## Style
|
## Style
|
||||||
|
|
||||||
|
|
Loading…
Reference in a new issue