Commit graph

24 commits

Author SHA1 Message Date
Yangshun Tay
55e676cb25
misc: add command to run prettier on docs (#2102)
* misc: add command to run prettier on docs

* Fix GH issue template

* Fix tests

* Add prettier-docs command to precommit
2019-12-07 21:56:30 -08:00
Yangshun Tay
a690d34af0
feat(v1): allow specifying meta desc in front matter (#1859)
* feat(v1): allow specifying meta desc in front matter

* misc(v2): sync with v1
2019-10-20 11:17:10 -07:00
Yangshun Tay
9f6460fde0 misc: facebook/Docusaurus -> facebook/docusaurus 2019-10-12 01:11:34 -07:00
Danny Hurlburt
684a2461bd docs: Fix Rendering of <AUTOGENERATED_TABLE_OF_CONTENTS> Tag on API - Markdown Features Page (#1617) 2019-07-12 23:32:52 +08:00
Hongarc
f18e07343c docs: fix typo for docs folder (#1484)
* docs: fix typo for `docs` folder

* docs: request change for #1484

* Update api-doc-markdown.md
2019-05-17 10:26:55 -07:00
Yangshun Tay
dcd3361413 misc: update docs for new features 2019-01-23 23:20:11 -08:00
Fienny Angelina
5ce85e5b5e feat: code block tab (#1063)
* Try to find a way to recognize the codeblock tabs, its title, and
where it ends
- I try using DOCUSAURUS_CODE_TABS to mark the start
- Use TAB_TITLE to mark the title of the tab
- END_TAB to mark the end of that tab
- END_DOCUSAURUS_CODE_TABS to mark the end of the whole code blocks
then parse using regex and render accordingly

* Added on click hook

* Added example on how to write it, how to use it, how it will look like can be reverted later

* Fix css error

* - Move addEventListener part to lib/static
- Remove comments

* Add documentation

* Remove examples

* Change syntax of the codetabs
2019-01-23 21:48:01 -08:00
maxaggedon
2df14feafd feat: use 'sidebar_label' instead of 'title' in prev/next buttons (#1122)
* feat: use 'sidebar_label' instead of 'title' in prev/next buttons

* docs: update 'sidebar_label' description
2018-11-22 18:36:05 +08:00
tsmrachel
54b76628f1 docs: specify markdown flavor support (#1118)
* docs : #1108 specify markdown flavor support

* Update api-doc-markdown.md
2018-11-18 21:07:57 -08:00
aenuros
edde297504 docs: how to add "Copy" button to code blocks (#1047)
* Update guides-custom-pages.md

Guide on how to add "Copy" to clipboard buttons on code blocks in Docusaurus.

* Update guides-custom-pages.md

Changed wall of text to be a link to a gist describing the code you need to add to add copy clipboard

* Add to markdown instead

* Update guides-custom-pages.md
2018-10-24 01:52:55 -04:00
John Reese
75538395be Fix table of contents documentation typo (#873) 2018-07-27 11:07:56 +07:00
Yangshun Tay
1094dbd352
CSS revamp - Improve typography and overall styling (#757)
* Improve CSS code

* Fix blog layout

* Fix

* Refactor onPageNav

* More fixes

* Fix docs nav

* Use alternative hack

* Tweak clearfix
2018-06-19 21:46:15 -07:00
Yangshun Tay
18c01327a3 Reformat, proofread and tidy up docs (#749) 2018-06-10 08:02:04 -07:00
Endilie Yacop Sucipto
c8bc00a3a7 Enable using Prism for syntax highlighting (#735)
* Enable user to use prism.js as syntax highlighter

* add package-lock

* if 'usePrism' is true, use prismjs on all languages

* don't get lang by hljs if use prism

* Update api-site-config.md

* Update api-doc-markdown.md

* only load prism css when usePrism is true
2018-06-09 11:38:01 -07:00
Yangshun Tay
a9a39817d4
Use proper syntax highlighting for code blocks (#615)
* Better syntax highlighting

* Better syntax highlighting
2018-04-27 22:51:38 -07:00
Jason Gauci
6dd6ead19f Add hide_title metadata that hides the title text on the top of the doc (#540) 2018-04-11 17:56:56 -07:00
Glavin Wiechert
41750667cd Allow edit URL to be customized with doc metadata (#443) 2018-02-11 16:43:37 -08:00
larsville
546cc8c7c5 Update api-doc-markdown.md (#440)
remove superfluous apostrophes
2018-02-10 21:10:12 -08:00
Lachlan Campbell
0a9aa41538 Fix form of its (#329) 2017-12-20 07:32:07 -08:00
Héctor Ramos
73b9a1128b Switch to GFM-style heading anchors (#164) 2017-10-26 16:12:17 -07:00
Héctor Ramos
fb294ab845 [markdown] Remove client-side syntax highlighting (#189)
* Remove client side highlighting

* Update CSS rules to render plain code blocks with expected left border

* Add back codeColor background color config

* Ensure all pre code blocks use Highlight.js classes
2017-10-26 12:07:02 -07:00
Héctor Ramos
b832176dc6 [markdown] Switch to Remarkable (#153)
* Switch to Remarkable
* Clean up references to custom code blocks
* Remove valdiateDOMNesting warning
* Add syntax highlighting
* Add Reason support
* Breaking change: prismColor to codeColor, remove CompLibrary.Prism, expose hljs
* Completely remove Prism and associated CSS rules
* Support loading plugins and scripts
* Remove CSS rules, allowing Highlight.js theme to be used entirely
* Remove unnecessary webplayer script
2017-10-24 09:45:21 -07:00
Frank Li
120678be05 Fix weird syntax highlighting in markdown features doc 2017-08-16 17:08:04 -07:00
Frank Li
5f09602440 Rename documents 2017-08-15 14:07:02 -07:00
Renamed from docs/doc-markdown.md (Browse further)