larryh/corso
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Minor docs tweaks (#71)

Browse Source 
- Better broken link error checking
- Link to Mermaid
This commit is contained in:
Niraj Tolia 2022-05-24 12:39:08 -07:00 committed by GitHub
parent 5739f903ff
commit 06608be38e
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
2 changed files with 2 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

1
docs/README.md
View File

@ -1,6 +1,7 @@
# Corso documentation # Corso documentation
Corso documentation uses [Docusaurus 2](https://docusaurus.io/), a modern static website generator. Corso documentation uses [Docusaurus 2](https://docusaurus.io/), a modern static website generator.
[Mermaid](https://mermaid-js.github.io/mermaid/) provides support for native diagrams in Markdown.
## Requirements ## Requirements

2
docs/docusaurus.config.js
View File

@ -11,7 +11,7 @@ const config = {
url: 'https://corsobackup.io', url: 'https://corsobackup.io',
baseUrl: '/', baseUrl: '/',
onBrokenLinks: 'throw', onBrokenLinks: 'throw',
onBrokenMarkdownLinks: 'warn', onBrokenMarkdownLinks: 'throw',
favicon: 'img/corso.svg', favicon: 'img/corso.svg',
// GitHub pages deployment config. // GitHub pages deployment config.