forked from facebook/docusaurus
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
46 changed files
with
2,262 additions
and
2,262 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,26 +1,26 @@ | ||
| --- | ||
| id: docusaurus | ||
| title: docusaurus | ||
| --- | ||
|
|
||
| <h1 align="center"> | ||
| <p align="center">Docusaurus</p> | ||
| <a href="https://docusaurus.io"><img src="/img/slash-introducing.png" alt="Docusaurus"></a> | ||
| </h1> | ||
|
|
||
| <p align="center"> | ||
| <a href="https://www.npmjs.com/package/docusaurus"><a href="#backers" alt="sponsors on Open Collective"><img src="https://opencollective.com/Docusaurus/backers/badge.svg" /></a> <a href="#sponsors" alt="Sponsors on Open Collective"><img src="https://opencollective.com/Docusaurus/sponsors/badge.svg" /></a> <img src="https://img.shields.io/npm/v/docusaurus.svg?style=flat" alt="npm version"></a> | ||
| <a href="https://circleci.com/gh/facebook/Docusaurus"><img src="https://circleci.com/gh/facebook/Docusaurus.svg?style=shield" alt="CircleCI Status"></a> | ||
| <a href="CONTRIBUTING.md#pull-requests"><img src="https://img.shields.io/badge/PRs-welcome-brightgreen.svg" alt="PRs Welcome"></a> | ||
| <a href="https://discord.gg/docusaurus"><img src="https://img.shields.io/badge/chat-on%20discord-7289da.svg" alt="Chat"></a> | ||
| <a href="https://github.com/prettier/prettier"><img alt="code style: prettier" src="https://img.shields.io/badge/code_style-prettier-ff69b4.svg?style=flat-square"></a> | ||
| <a href="https://github.com/facebook/jest"><img src="https://img.shields.io/badge/tested_with-jest-99424f.svg" alt="Tested with Jest"></a> | ||
| </p> | ||
|
|
||
| ## Introduction | ||
|
|
||
| Docusaurus is a project for easily building, deploying, and maintaining open source project websites. | ||
|
|
||
| * **Simple to Start** Docusaurus is built to be easy to [get up and running](https://docusaurus.io/docs/en/installation.html) in as little time possible. We've built Docusaurus to handle the website build process so you can focus on your project. | ||
| * **Localizable** Docusaurus ships with [localization support](https://docusaurus.io/docs/en/translation.html) via CrowdIn. Empower and grow your international community by translating your documentation. | ||
| --- | ||
| id: docusaurus | ||
| title: docusaurus | ||
| --- | ||
|
|
||
| <h1 align="center"> | ||
| <p align="center">Docusaurus</p> | ||
| <a href="https://docusaurus.io"><img src="/img/slash-introducing.png" alt="Docusaurus"></a> | ||
| </h1> | ||
|
|
||
| <p align="center"> | ||
| <a href="https://www.npmjs.com/package/docusaurus"><a href="#backers" alt="sponsors on Open Collective"><img src="https://opencollective.com/Docusaurus/backers/badge.svg" /></a> <a href="#sponsors" alt="Sponsors on Open Collective"><img src="https://opencollective.com/Docusaurus/sponsors/badge.svg" /></a> <img src="https://img.shields.io/npm/v/docusaurus.svg?style=flat" alt="npm version"></a> | ||
| <a href="https://circleci.com/gh/facebook/Docusaurus"><img src="https://circleci.com/gh/facebook/Docusaurus.svg?style=shield" alt="CircleCI Status"></a> | ||
| <a href="CONTRIBUTING.md#pull-requests"><img src="https://img.shields.io/badge/PRs-welcome-brightgreen.svg" alt="PRs Welcome"></a> | ||
| <a href="https://discord.gg/docusaurus"><img src="https://img.shields.io/badge/chat-on%20discord-7289da.svg" alt="Chat"></a> | ||
| <a href="https://github.com/prettier/prettier"><img alt="code style: prettier" src="https://img.shields.io/badge/code_style-prettier-ff69b4.svg?style=flat-square"></a> | ||
| <a href="https://github.com/facebook/jest"><img src="https://img.shields.io/badge/tested_with-jest-99424f.svg" alt="Tested with Jest"></a> | ||
| </p> | ||
|
|
||
| ## Introduction | ||
|
|
||
| Docusaurus is a project for easily building, deploying, and maintaining open source project websites. | ||
|
|
||
| * **Simple to Start** Docusaurus is built to be easy to [get up and running](https://docusaurus.io/docs/en/installation.html) in as little time possible. We've built Docusaurus to handle the website build process so you can focus on your project. | ||
| * **Localizable** Docusaurus ships with [localization support](https://docusaurus.io/docs/en/translation.html) via CrowdIn. Empower and grow your international community by translating your documentation. | ||
| * **Customizable** While Docusaurus ships with the key pages and sections you need to get started, including a home page, a docs section, a [blog](https://docusaurus.io/docs/en/blog.html), and additional support pages, it is also [customizable](https://docusaurus.io/docs/en/custom-pages.html) as well to ensure you have a site that is [uniquely yours](https://docusaurus.io/docs/en/api-pages.html). |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,51 +1,51 @@ | ||
| --- | ||
| id: bar | ||
| title: My Title | ||
| --- | ||
|
|
||
| # Remarkable | ||
|
|
||
| > Experience real-time editing with Remarkable! | ||
| Click the `clear` link to start with a clean slate, or get the `permalink` to share or save your results. | ||
|
|
||
| *** | ||
|
|
||
| # h1 Heading | ||
| ## h2 Heading | ||
| ### h3 Heading | ||
| #### h4 Heading | ||
| ##### h5 Heading | ||
| ###### h6 Heading | ||
|
|
||
|
|
||
| ## Horizontal Rules | ||
|
|
||
| This is horizontal rule | ||
|
|
||
| ___ | ||
|
|
||
| *** | ||
|
|
||
| *** | ||
|
|
||
|
|
||
| ## Emphasis | ||
|
|
||
| **This is bold text** | ||
|
|
||
| __This is bold text__ | ||
|
|
||
| *This is italic text* | ||
|
|
||
| _This is italic text_ | ||
|
|
||
| ~~Deleted text~~ | ||
|
|
||
| Superscript: 19^th^ | ||
|
|
||
| Subscript: H~2~O | ||
|
|
||
| ++Inserted text++ | ||
|
|
||
| ==Marked text== | ||
| --- | ||
| id: bar | ||
| title: My Title | ||
| --- | ||
|
|
||
| # Remarkable | ||
|
|
||
| > Experience real-time editing with Remarkable! | ||
| Click the `clear` link to start with a clean slate, or get the `permalink` to share or save your results. | ||
|
|
||
| *** | ||
|
|
||
| # h1 Heading | ||
| ## h2 Heading | ||
| ### h3 Heading | ||
| #### h4 Heading | ||
| ##### h5 Heading | ||
| ###### h6 Heading | ||
|
|
||
|
|
||
| ## Horizontal Rules | ||
|
|
||
| This is horizontal rule | ||
|
|
||
| ___ | ||
|
|
||
| *** | ||
|
|
||
| *** | ||
|
|
||
|
|
||
| ## Emphasis | ||
|
|
||
| **This is bold text** | ||
|
|
||
| __This is bold text__ | ||
|
|
||
| *This is italic text* | ||
|
|
||
| _This is italic text_ | ||
|
|
||
| ~~Deleted text~~ | ||
|
|
||
| Superscript: 19^th^ | ||
|
|
||
| Subscript: H~2~O | ||
|
|
||
| ++Inserted text++ | ||
|
|
||
| ==Marked text== |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,74 +1,74 @@ | ||
| --- | ||
| id: baz | ||
| title: Test Markdown | ||
| --- | ||
|
|
||
| ## Images | ||
|
|
||
|  | ||
|
|
||
| Like links, Images also have a footnote style syntax | ||
|
|
||
| ![Alt text][id] | ||
|
|
||
| With a reference later in the document defining the URL location: | ||
|
|
||
| ## Links | ||
|
|
||
| [link text](http://dev.nodeca.com) | ||
|
|
||
| [link with title](http://nodeca.github.io/pica/demo/ "title text!") | ||
|
|
||
| Autoconverted link https://github.com/nodeca/pica (enable linkify to see) | ||
|
|
||
|
|
||
|
|
||
| ## Footnotes | ||
|
|
||
| Footnote 1 link[^first]. | ||
|
|
||
| Footnote 2 link[^second]. | ||
|
|
||
| Inline footnote^[Text of inline footnote] definition. | ||
|
|
||
| Duplicated footnote reference[^second]. | ||
|
|
||
| [^first]: Footnote **can have markup** | ||
|
|
||
| and multiple paragraphs. | ||
|
|
||
| [^second]: Footnote text. | ||
|
|
||
|
|
||
| ## Definition lists | ||
|
|
||
| Term 1 | ||
|
|
||
| : Definition 1 | ||
| with lazy continuation. | ||
|
|
||
| Term 2 with *inline markup* | ||
|
|
||
| : Definition 2 | ||
|
|
||
| { some code, part of Definition 2 } | ||
|
|
||
| Third paragraph of definition 2. | ||
|
|
||
| _Compact style:_ | ||
|
|
||
| Term 1 | ||
| ~ Definition 1 | ||
|
|
||
| Term 2 | ||
| ~ Definition 2a | ||
| ~ Definition 2b | ||
|
|
||
|
|
||
| ## Abbreviations | ||
|
|
||
| This is HTML abbreviation example. | ||
|
|
||
| It converts "HTML", but keep intact partial entries like "xxxHTMLyyy" and so on. | ||
|
|
||
| *[HTML]: Hyper Text Markup Language | ||
| --- | ||
| id: baz | ||
| title: Test Markdown | ||
| --- | ||
|
|
||
| ## Images | ||
|
|
||
|  | ||
|
|
||
| Like links, Images also have a footnote style syntax | ||
|
|
||
| ![Alt text][id] | ||
|
|
||
| With a reference later in the document defining the URL location: | ||
|
|
||
| ## Links | ||
|
|
||
| [link text](http://dev.nodeca.com) | ||
|
|
||
| [link with title](http://nodeca.github.io/pica/demo/ "title text!") | ||
|
|
||
| Autoconverted link https://github.com/nodeca/pica (enable linkify to see) | ||
|
|
||
|
|
||
|
|
||
| ## Footnotes | ||
|
|
||
| Footnote 1 link[^first]. | ||
|
|
||
| Footnote 2 link[^second]. | ||
|
|
||
| Inline footnote^[Text of inline footnote] definition. | ||
|
|
||
| Duplicated footnote reference[^second]. | ||
|
|
||
| [^first]: Footnote **can have markup** | ||
|
|
||
| and multiple paragraphs. | ||
|
|
||
| [^second]: Footnote text. | ||
|
|
||
|
|
||
| ## Definition lists | ||
|
|
||
| Term 1 | ||
|
|
||
| : Definition 1 | ||
| with lazy continuation. | ||
|
|
||
| Term 2 with *inline markup* | ||
|
|
||
| : Definition 2 | ||
|
|
||
| { some code, part of Definition 2 } | ||
|
|
||
| Third paragraph of definition 2. | ||
|
|
||
| _Compact style:_ | ||
|
|
||
| Term 1 | ||
| ~ Definition 1 | ||
|
|
||
| Term 2 | ||
| ~ Definition 2a | ||
| ~ Definition 2b | ||
|
|
||
|
|
||
| ## Abbreviations | ||
|
|
||
| This is HTML abbreviation example. | ||
|
|
||
| It converts "HTML", but keep intact partial entries like "xxxHTMLyyy" and so on. | ||
|
|
||
| *[HTML]: Hyper Text Markup Language |
Oops, something went wrong.