From 171a8b2baaf8a92867c00ced46d34836a2cd42ee Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?St=C3=A9phane=20Goetz?= Date: Thu, 18 May 2017 22:51:59 +0200 Subject: [PATCH] Clarify which flavor of markdown is supported #460 --- README.md | 5 +++-- docs/00_Getting_Started.md | 2 +- ...itHub_Flavored_Markdown.md => CommonMark_compliant.md} | 8 +++++++- docs/01_Features/Internal_links.md | 4 ++-- docs/01_Features/Multilanguage.md | 4 ++-- docs/02_Examples/05_Code_Highlighting.md | 2 +- docs/05_Configuration/_index.md | 4 ++-- docs/_index.md | 2 +- 8 files changed, 19 insertions(+), 12 deletions(-) rename docs/01_Features/{GitHub_Flavored_Markdown.md => CommonMark_compliant.md} (93%) diff --git a/README.md b/README.md index 2ab607e..6d18c73 100755 --- a/README.md +++ b/README.md @@ -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 diff --git a/docs/00_Getting_Started.md b/docs/00_Getting_Started.md index 7e83bc5..f091d7c 100644 --- a/docs/00_Getting_Started.md +++ b/docs/00_Getting_Started.md @@ -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) diff --git a/docs/01_Features/GitHub_Flavored_Markdown.md b/docs/01_Features/CommonMark_compliant.md similarity index 93% rename from docs/01_Features/GitHub_Flavored_Markdown.md rename to docs/01_Features/CommonMark_compliant.md index 021a182..2802bea 100644 --- a/docs/01_Features/GitHub_Flavored_Markdown.md +++ b/docs/01_Features/CommonMark_compliant.md @@ -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).* diff --git a/docs/01_Features/Internal_links.md b/docs/01_Features/Internal_links.md index 818a846..419cf64 100644 --- a/docs/01_Features/Internal_links.md +++ b/docs/01_Features/Internal_links.md @@ -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) diff --git a/docs/01_Features/Multilanguage.md b/docs/01_Features/Multilanguage.md index 8cde8ff..4017c14 100644 --- a/docs/01_Features/Multilanguage.md +++ b/docs/01_Features/Multilanguage.md @@ -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 diff --git a/docs/02_Examples/05_Code_Highlighting.md b/docs/02_Examples/05_Code_Highlighting.md index 0e0db2e..e723d73 100644 --- a/docs/02_Examples/05_Code_Highlighting.md +++ b/docs/02_Examples/05_Code_Highlighting.md @@ -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** diff --git a/docs/05_Configuration/_index.md b/docs/05_Configuration/_index.md index f5e5f30..3e5ba07 100644 --- a/docs/05_Configuration/_index.md +++ b/docs/05_Configuration/_index.md @@ -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 diff --git a/docs/_index.md b/docs/_index.md index b7e51b5..5c22df4 100644 --- a/docs/_index.md +++ b/docs/_index.md @@ -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)