D3Public
/
daux.io
8
0
Fork 0
Code Pull Requests Releases Activity

Clarify which flavor of markdown is supported #460

This commit is contained in:
Stéphane Goetz 2017-05-18 22:51:59 +02:00
parent ebb1e088c3
commit 171a8b2baa
8 changed files with 19 additions and 12 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

5
README.md
View File

@ -9,12 +9,13 @@
[![Total Downloads](https://img.shields.io/packagist/dt/justinwalsh/daux.io.svg?style=flat-square)](https://packagist.org/packages/justinwalsh/daux.io)
**Daux.io** is an documentation generator that uses a simple folder structure and Markdown files to create custom documentation on the fly. It helps you create great looking documentation in a developer friendly way.
**Daux.io** is a documentation generator that uses a simple folder structure and Markdown files to create custom documentation on the fly. It helps you create great looking documentation in a developer friendly way.
## Features
* 100% Mobile Responsive
* Supports GitHub Flavored Markdown
* CommonMark compliant (a Markdown specification)
* Supports Markdown tables
* Auto created homepage/landing page
* Auto Syntax Highlighting
* Auto Generated Navigation

2
docs/00_Getting_Started.md
View File

@ -8,7 +8,7 @@
* [Auto Generated Navigation / Page sorting](01_Features/Navigation_and_Sorting.md)
* [Internal documentation links](01_Features/Internal_links.md)
* [Github Flavored Markdown](01_Features/GitHub_Flavored_Markdown.md)
* [CommonMark compliant](01_Features/CommonMark_compliant.md)
* [Auto created homepage/landing page](01_Features/Landing_page.md)
* [Multiple Output Formats](01_Features/Multiple_Output_Formats.md)
* [Multiple Languages Support](01_Features/Multilanguage.md)

8
docs/01_Features/GitHub_Flavored_Markdown.md → docs/01_Features/CommonMark_compliant.md
View File

@ -1,3 +1,9 @@
As we support CommonMark, a broad range of markdown features is available to you.
Many of the features shown below were known as Github Flavored Markdown.
We all like making lists
------------------------
@ -113,4 +119,4 @@ Here's an image.
Note: to use images on a landing page (index.md), prefix the image URL with the name of the directory it appears in, omitting the numerical prefix used to order the sections. For example in this section, to display this image on the landing page (index.md), the URL for the image would be "Features/sampleimage.png" to display the same image.
*View the [source of this content](https://github.com/justinwalsh/daux.io/blob/master/docs/01_Features/GitHub_Flavored_Markdown.md).*
*View the [source of this content](https://github.com/justinwalsh/daux.io/blob/master/docs/01_Features/CommonMark_compliant.md).*

4
docs/01_Features/Internal_links.md
View File

@ -10,13 +10,13 @@ If your file structure looks like this:
```
├── 00_Getting_Started.md
├── 01_Features
│ ├── 01_GitHub_Flavored_Markdown.md
│ ├── CommonMark_compliant.md
├── 02_Examples
│ ├── Hello_World.md
│ ├── 05_Code_Highlighting.md
```
From the page `01_Features/01_GitHub_Flavored_Markdown.md`, all the following links would be valid:
From the page `01_Features/CommonMark_compliant.md`, all the following links would be valid:
[Getting Started](../00_Getting_Started.md)
[Getting Started](../00_Getting_Started.html)

4
docs/01_Features/Multilanguage.md
View File

@ -15,7 +15,7 @@ You will the need separate directories for each language in `docs/` folder.
│ ├── en
│ │ ├── 00_Getting_Started.md
│ │ ├── 01_Examples
│ │ │ ├── 01_GitHub_Flavored_Markdown.md
│ │ │ ├── 01_CommonMark_compliant.md
│ │ │ ├── 05_Code_Highlighting.md
│ │ ├── 05_More_Examples
│ │ │ ├── Hello_World.md
@ -23,7 +23,7 @@ You will the need separate directories for each language in `docs/` folder.
│ ├── de
│ │ ├── 00_Getting_Started.md
│ │ ├── 01_Examples
│ │ │ ├── 01_GitHub_Flavored_Markdown.md
│ │ │ ├── 01_CommonMark_compliant.md
│ │ │ ├── 05_Code_Highlighting.md
│ │ ├── 05_More_Examples
│ │ │ ├── Hello_World.md

2
docs/02_Examples/05_Code_Highlighting.md
View File

@ -1,6 +1,6 @@
Highlight.js highlights syntax in code examples on blogs, forums and in fact on any web pages. It's very easy to use because it works automatically: finds blocks of code, detects a language, highlights it. [Learn more.](https://highlightjs.org/)
You can even use [Github Flavored Markdown](!Features/GitHub_Flavored_Markdown)
You can even use [Github Flavored Markdown](!Features/CommonMark_compliant)
**Python**

4
docs/05_Configuration/_index.md
View File

@ -92,7 +92,7 @@ Directory structure:
│ ├── en
│ │ ├── 00_Getting_Started.md
│ │ ├── 01_Examples
│ │ │ ├── 01_GitHub_Flavored_Markdown.md
│ │ │ ├── 01_CommonMark_compliant.md
│ │ │ ├── 05_Code_Highlighting.md
│ │ ├── 05_More_Examples
│ │ │ ├── Hello_World.md
@ -100,7 +100,7 @@ Directory structure:
│ ├── de
│ │ ├── 00_Getting_Started.md
│ │ ├── 01_Examples
│ │ │ ├── 01_GitHub_Flavored_Markdown.md
│ │ │ ├── 01_CommonMark_compliant.md
│ │ │ ├── 05_Code_Highlighting.md
│ │ ├── 05_More_Examples
│ │ │ ├── Hello_World.md

2
docs/_index.md
View File

@ -12,7 +12,7 @@
* [Auto Generated Navigation / Page sorting](01_Features/Navigation_and_Sorting.md)
* [Internal documentation links](01_Features/Internal_links.md)
* [Github Flavored Markdown](01_Features/GitHub_Flavored_Markdown.md)
* [CommonMark compliant](01_Features/CommonMark_compliant.md)
* [Auto created homepage/landing page](01_Features/Landing_page.md)
* [Multiple Output Formats](01_Features/Multiple_Output_Formats.md)
* [Multiple Languages Support](01_Features/Multilanguage.md)