15308555518/ docusaurus
1
0
Fork 0
mirror of https://github.com/facebook/docusaurus.git synced 2025-12-31 23:54:25 +00:00
Code Issues Actions 5 Packages Projects Releases Wiki Activity
940 Commits 49 Branches 181 Tags 1.1 GiB
Commit Graph

205 Commits

Author SHA1 Message Date
Joel Marcey 8e5b5c9f0f
Update publishing docs and API information (#372) 
Some environment variables can be set by the CircleCI build itself
Document `USE_SSH`
 2018-01-03 17:03:14 -08:00
Joel Marcey 7b13b75695 Updated publishing documentation to make to check write access for user 2018-01-03 13:54:54 -08:00
Thomas Gratier 5805149eff Remove uneeded run in syntax to run local server (#354) 2017-12-27 14:39:28 -08:00
Átila Camurça Alves e6a1844299 Update getting-started-installation.md (#331) 
instruction to run local `docusaurus-init` via `npx`
 2017-12-20 11:49:47 -08:00
Ricky Vetter d79ff9eaf0 add docs for wrapPagesHTML (#332) 2017-12-20 10:35:50 -08:00
Lachlan Campbell 0a9aa41538 Fix form of its (#329) 2017-12-20 07:32:07 -08:00
Thomas Broadley b5fefcc676 docs: fix typos (#327) 2017-12-19 21:39:18 -08:00
Joel Marcey 83e8802d01 Add description for useEnglishUrl 2017-12-19 21:35:24 -08:00
azu e865ed88a0 Fix broken or redirected links (#302) 2017-12-17 16:44:07 -08:00
Joel Marcey 731251172e Version docs should say run `examples versions` 2017-12-16 16:33:50 -08:00
Joel Marcey 317fa99572 Add social buttons at the bottom of blog posts. 
Also, update the siteConfig api docs
 2017-12-13 20:10:27 -08:00
Eric Nakagawa fd835116ee Add dummy siteConfig.js for deploying, fixed indendation on publishing file (#285) 2017-12-13 15:59:43 -08:00
Joel Marcey d33489cf16 Update example URLs 2017-12-13 15:37:46 -08:00
Joel Marcey be1ea72237
Add About Slash page (#282) 
It will show up in the header as "About/" :)
 2017-12-13 15:27:35 -08:00
Héctor Ramos 11029cf02d Update build script (#272) 
* Copy dot files if present in the static folder, and add .circleci config to Docusaurus site

* Update docs
 2017-12-11 16:32:05 -08:00
Héctor Ramos 85e2c87124 Document how to tell Circle to ignore commits to gh-pages (#270) 2017-12-08 15:47:03 -08:00
Joel Marcey ef6f550700 Replace facebookexperimental with facebook (#266) 
Moving to the facebook GitHub org
 2017-12-07 10:52:12 -08:00
Joel Marcey 6772926572 Update publishing docs in lieu of #250 2017-12-04 09:15:41 -08:00
Héctor Ramos 31b70f053c Update docusaurus-publish (#250) 
* Update publish script to allow configuration via siteConfig.js file, as well as non-CircleCI env vars

* Use || instead of |
 2017-12-04 09:15:32 -08:00
Joel Marcey 70bd56eb93 Update translations guide 2017-11-17 14:38:37 -08:00
Joel Marcey 16aa42a705 Allow deploying docs from a branch other than `master` 
Still have to deploy to `gh-pages`
 2017-11-17 14:26:08 -08:00
Joel Marcey 59d5b58aa5 Update the publishing documentation 2017-11-17 14:04:47 -08:00
Christine Abernathy 76c1dace46 Fix for consistency and completeness (#229) 
* Fixes for consistency

* Update for creating example versions page
 2017-11-15 12:13:37 -08:00
Christopher Chedeau c407cdf96f Enable stylesheets as a parallel to scripts (#225) 
* Enable stylesheets as a parallel to scripts

Also moves the scripts above the custom stylesheet to follow the comment :)

* Update api-site-config.md
 2017-11-13 17:54:24 -08:00
Eric Nakagawa 8d14f8fb02
Merge pull request #217 from JoelMarcey/custom-docs-subdir 
Allow custom path for the location of documentation
 2017-11-13 13:50:39 -08:00
Christine Abernathy 522e59d739 Add cname to config doc (#222) 2017-11-10 15:00:53 -08:00
Joel Marcey 53265c2d15
Update navigation and sidebar docs (#216) 2017-11-09 11:12:45 -08:00
Joel Marcey e273dfc13b Allow the docs not to just be in a folder called `docs` 
Also:
- regex escaping
- update api documentation
 2017-11-09 09:55:26 -08:00
Joel Marcey 9f32a28d32
Update custom pages document (#214) 2017-11-08 18:40:30 -08:00
Joel Marcey 592c4fc54f
Update publishing a site docs (#211) 2017-11-08 18:40:15 -08:00
Christine Abernathy 4a198ae5b2 Specify crowdin.yaml location (#215) 
Minor update to specify where crowdin.yaml is located
 2017-11-08 16:38:48 -08:00
Joel Marcey ab169640d4
Update site creation docs (#204) 2017-11-01 09:48:28 -07:00
Joel Marcey 1324ddfa47
Update site preparation docs (#203) 2017-11-01 09:48:14 -07:00
Joel Marcey 8123acf2d1
Update installation documentation to use the init script (#200) 2017-10-31 09:23:48 -07:00
Héctor Ramos 09354ab738 [BREAKING] Rename Marked to MarkdownBlock (#162) 
* 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

* Rename Marked to MarkdownBlock

* Rename Marked to MarkdownBlock

* Remove Marked.js
 2017-10-30 15:47:13 -07:00
Héctor Ramos 20122f6c56 Update guides-versioning.md 2017-10-26 17:35:09 -07:00
Héctor Ramos 603b9cd84c Prefix, not append (#191) 2017-10-26 16:14:18 -07:00
Héctor Ramos 73b9a1128b Switch to GFM-style heading anchors (#164) 2017-10-26 16:12:17 -07:00
Héctor Ramos ba666cc6ae Remove sourceCodeButton config key (#181) 2017-10-26 12:16:36 -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
Eric Nakagawa a6bad7f92d Merge pull request #176 from ericnakagawa/write-translations-autogen 
Improve translations guide + add comment about translations autogen
 2017-10-24 19:21:19 -07:00
Héctor Ramos 9bc6d27f32 Break up long line that was messing up our page. (#174) 
* Break up long line that was messing up our page.

* Remove file that should not be in source control
 2017-10-24 16:15:50 -07:00
Eric Nakagawa fcc168af42 Add more info around syncing to crowdin 2017-10-24 15:31:52 -07:00
Eric Nakagawa 5617987bf2 Added a note about disabling English as a language 2017-10-24 15:23:18 -07:00
Eric Nakagawa fdc8b1ba72 Add a link to the crowdin-cli download instructions 2017-10-24 15:19:13 -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
Eric Nakagawa bcba05ae03 Adds sitemap.xml. Adds 'Help Translate' to translatable strings. Error messages and fn name cleanups. (#136) 
* added a note about needing more than one language to be enabled to allow for a drop down

* Removing debug statements

* Add 'Help Translate' to translatable strings, improves error messages around missing translated strings, calls write-translations on some routes

* Adds sitemap.xml to live server and build. Versioning not supported. -- Also did some file name and module cache cleanups.
 2017-10-18 12:55:58 -07:00
Ricky Vetter 768ed88978 Add option to avoid indexing site (#142) 2017-10-18 11:35:30 -07:00
Héctor Ramos 14dfcff769 Support algoliaOptions object as value in siteConfig.js (#113) 2017-10-04 19:13:30 -07:00
Ricky Vetter 9c7d8e55a9 add sourceCodeButton to site config (#93) 2017-10-03 15:20:35 -07:00
Joel Marcey 0d88c7d430 Remove duplicative publish doc 2017-09-29 15:38:58 -07:00
Eric Nakagawa a818d8fd7a Update README, clean up getting started sections (#100) 2017-09-29 15:38:03 -07:00
Héctor Ramos 5c2c8570d2 Publishing your site Guide (#55) 2017-09-29 15:31:27 -07:00
Eric Nakagawa dc835770a0 RSS/ATOM Feed added, Prism changes, and global Copyright notice. (#94) 
* Add Reason support to Prism.js

* Add XML/ATOM feed. Generates for both localhost and build script. Adds meta links to feeds to all html files.

* Updated /core/Footer.js to pull from siteConfig
 2017-09-27 12:49:09 -07:00
Eric Nakagawa 8e9808c0f4 Re-arranging of files to move localized base files in /docs from /docs/en, updates to template crowdin.yaml, update to package.json to make calling crowdin easier. Updating documentation to reflect. 2017-09-21 08:36:30 -07:00
Eric Nakagawa d379f58581 Adding crowdin config to Docusaurs. Content updates to: README.md, guides-translation.md. Moved docs into /docs/en. 2017-09-20 21:09:55 -07:00
Frank Li 469593a55e Update siteConfig doc 2017-08-17 11:08:17 -07:00
Eric Vicenti 5f6dab0b6c Update structure of blog guide 2017-08-16 18:56:37 -07:00
Frank Li 120678be05 Fix weird syntax highlighting in markdown features doc 2017-08-16 17:08:04 -07:00
Frank Li e15cf3b919 Update customize link in site creation doc 2017-08-16 17:01:32 -07:00
Frank Li fe9c908b14 Update commands doc 2017-08-16 16:08:27 -07:00
Frank Li b5fb5c917c Update links in commands 2017-08-16 15:58:20 -07:00
Frank Li dfcb3452c8 Add custom pages guide (#69) 
* Add custom pages guide

* Update custom pages guide
 2017-08-16 15:54:00 -07:00
Frank Li a1e20736da Add Pages and Styles API doc (#67) 
* Add Pages and Styles doc

* Update pages api doc
 2017-08-16 15:53:43 -07:00
Héctor Ramos e8a90f7f48 Add Commands API Reference (#50) 2017-08-16 12:51:51 -07:00
Joel Marcey 271e224702 Add more information to the blog guide 2017-08-16 12:01:56 -07:00
Eric Vicenti aa014b2109 Basic blog guide (#59) 2017-08-16 11:52:55 -07:00
Frank Li df0f95e36f Update links in site creation doc 2017-08-15 14:17:30 -07:00
Frank Li fc391a05a5 Update navigation guide 2017-08-15 14:14:07 -07:00
Frank Li 15358cad71 Update navigation guide 2017-08-15 14:13:30 -07:00
Frank Li 5f09602440 Rename documents 2017-08-15 14:07:02 -07:00
Frank Li bd3d55a80b Update documentation 2017-08-15 10:57:49 -07:00
Frank Li 9c0a69c3e0 Update site creation doc 2017-08-15 10:16:13 -07:00
Frank Li 0f618eff9f Update Markdown Features doc style 2017-08-14 16:27:52 -07:00
Frank Li 2f03158fd9 Update Markdown Features doc with blog post headers 2017-08-14 16:25:48 -07:00
Frank Li c3164c6dab Update markdown features doc 2017-08-11 15:24:45 -07:00
Frank Li 964e9e2108 Update doc metadata to use file name as id fallback and id as title fallback 2017-08-10 14:51:34 -07:00
Frank Li b9d06d383f Update translations guide 2017-08-10 13:46:29 -07:00
Frank Li 0fc7704a56 Merge pull request #54 from facebookexperimental/search-doc-options 
Update search guide
 2017-08-10 12:24:51 -07:00
Frank Li 5cc47ade89 Small update to translation guide 2017-08-09 17:26:02 -07:00
Frank Li b5d7f72b51 Update search guide 2017-08-09 10:41:19 -07:00
Frank Li aba6e93c5d Update getting-started-preparation.md 2017-08-08 15:38:25 -07:00
Frank Li f05f4b6fff Update search guide 2017-08-08 14:24:25 -07:00
Frank Li c182a96be9 Merge branch 'master' of https://github.com/facebookexperimental/Docusaurus into new-docs 2017-08-08 13:56:55 -07:00
Joel Marcey 27ee375d94 Remove header from old getting started page 
This content is being merged into other docs and guides

keep it around for reference before deleting it permanently.
 2017-08-08 12:00:17 -07:00
Joel Marcey bba7edd80f Update the Algolia search information (#49) 
* Update the Algolia search information

- It is a guide
- Rename the file, specifying that it is a guide
- Add a commented out Aloglia section to siteConfig.js

* Different search bar location flag
 2017-08-08 11:47:18 -07:00
Joel Marcey a56812cda3 Creating a site basics (#48) 2017-08-08 11:45:57 -07:00
Joel Marcey 0743515ff1 Add site preparation doc (#41) 
* Add site preparation doc

* Make website folder explicit

* Rebase
 2017-08-08 11:43:41 -07:00
Joel Marcey 21a7fab937 Add installation guide (#36) 2017-08-08 11:39:25 -07:00
Frank Li 483bc20513 Update versioning doc 2017-08-08 11:20:45 -07:00
Eric Vicenti b8af2f010d Merge branch 'master' of github.com:facebookexperimental/Docusaurus 2017-08-08 11:09:10 -07:00
Eric Vicenti 9e8d6d2148 Add navigation guide 2017-08-08 11:09:03 -07:00
Joel Marcey 29111623f8 Change some of the doc titles 2017-08-08 09:37:40 -07:00
Frank Li 94f78f9321 Change title versioning document title 2017-08-07 14:02:50 -07:00
Frank Li 3eb667cd32 Fix links in getting-started document 2017-08-07 14:00:17 -07:00
Joel Marcey c1bd371442 Update the sidebar to reflect our layout strategy (#32) 
Getting Started
Guides
API

Using current same content; they will change as the docathon moves along
 2017-08-07 13:57:30 -07:00
Frank Li 1fcb989225 Add versioning document 2017-08-07 13:53:56 -07:00
Frank Li b71ef8c0f1 Update website setup for new API 2017-08-07 10:34:53 -07:00
Frank Li bb35708791 Update documentation 2017-07-24 15:34:04 -07:00
Frank Li f309be78aa Add and update documentation (#23) 
* Add and update documentation

* Update documentation

* Update site config doc
 2017-07-20 17:02:34 -07:00
Frank Li 70ed75b046 Publish changes to start args to npm 2017-07-13 15:09:52 -07:00
Frank Li 6e433f45c3 Update translation.md 2017-07-12 12:19:38 -07:00
Frank Li 2256bc922e Update getting-started.md 2017-07-12 12:02:51 -07:00
Frank Li 48916d9f39 Update getting-started doc 2017-07-11 15:19:59 -07:00
Frank Li 429aa636d0 Add initial documentation 2017-07-11 15:17:47 -07:00