Skip to content

Commit 818e5f9

Browse files
committed
Edited readmes
1 parent 24e73f9 commit 818e5f9

File tree

3 files changed

+10
-21
lines changed

3 files changed

+10
-21
lines changed

README.md

+1-16
Original file line numberDiff line numberDiff line change
@@ -9,22 +9,7 @@ An ASP.NET Core markdown-based documentation engine.
99

1010
[Documentation](docs/index.md)
1111

12-
[Download `markdocs-gen`](https://ci.appveyor.com/api/projects/itgloballlc/markdocs/artifacts/artifacts/markdocs-gen.zip)
13-
14-
Installing `markdocs` command line tool
15-
---------------------------------------
16-
17-
Execute command:
18-
19-
```shell
20-
dotnet tool install -g ITGlobal.MarkDocs.CommandLineTool
21-
```
22-
23-
Then run:
24-
25-
```shell
26-
markdocs [command]
27-
```
12+
[Command-line tool (and a Docker app)](src/markdocs/README.md)
2813

2914
License
3015
-------

build.ps1

+1-5
Original file line numberDiff line numberDiff line change
@@ -84,11 +84,7 @@ function build-packages() {
8484
$VERSION = "0.0.0-dev"
8585
}
8686

87-
Get-ChildItem -Filter *.csproj -Path "./src" -Recurse -File | % {
88-
if ($_.Name -eq "markdocs-site.csproj") {
89-
return
90-
}
91-
87+
Get-ChildItem -Filter *.csproj -Path "./src" -Recurse -File | % {
9288
& dotnet pack --output $ARTIFACTS --no-restore -v q /nologo /p:Version=$VERSION /p:Configuration=$CONFIGURATION $_.FullName
9389
if ($LASTEXITCODE -ne 0) {
9490
Write-Host "'dotnet pack' exited with $LASTEXITCODE"

src/markdocs/README.md

+8
Original file line numberDiff line numberDiff line change
@@ -16,6 +16,14 @@ Then run:
1616
markdocs [command]
1717
```
1818

19+
## Update
20+
21+
If markdocs CLI tool is already installed, type the following command to update it:
22+
23+
```shell
24+
dotnet tool update -g ITGlobal.MarkDocs.CommandLineTool
25+
```
26+
1927
## Commands
2028

2129
* `markdocs lint` - runs a linter over a directory

0 commit comments

Comments
 (0)