15308555518/ docusaurus
1
0
Fork 0
mirror of https://github.com/facebook/docusaurus.git synced 2025-12-30 05:52:50 +00:00
Code Issues Actions 6 Packages Projects Releases Wiki Activity
940 Commits 49 Branches 181 Tags 1.1 GiB
Commit Graph

205 Commits

Author SHA1 Message Date
Eric Nakagawa 4e575e9234 Documents `Blog Only` Mode and Netlify Hosting (#595) 
* Documentation, newest: Add steps for hosting on Netlify

* Documents how to run a blog-only site
 2018-04-23 13:45:02 -07:00
Long Mai 33d4e4a4ec Simplify installation steps (#519) 
* simplify installation steps

Since docusaurus-init is run seldomly, npx keeps it simpler,
and subsequent runs will be using the latest version.

Outdated provides more meaningful view of current and latest version

* add more doc on who can use npx

* Make yarn and npm commands more specific
 2018-04-23 00:13:29 -07:00
huang.xinghui aa32ff4a55 Add customize highlight.theme custom path support (#517) 
* add themeUrl option to support custom theme file path

* Update api-site-config.md
 2018-04-19 08:04:49 -07:00
Amy Lam 57cddb4d08 Allow customizing of blog author image URL documentation (#577) 
* Rename authorImage to authorImageURL for clarity

Update documentation

* Fix typo

* Add documentation for authorImageURL

* Add support for authorImage

We will remove support for authorImage in favor of authorImageURL, after we remove authorImage from react-native-website

* Update guides-blog.md

* Update guides-blog.md
 2018-04-17 23:15:27 -07:00
Joel Marcey 47d08bf1da
Update site config example in docs 2018-04-17 21:15:50 -07:00
Joel Marcey e738bbd99e
Add `twitterImage` to siteConfig options (#580) 2018-04-17 21:04:39 -07:00
Amy Lam f0197700c5 Add table to clarify versioning (#573) 2018-04-17 09:53:35 -07:00
Yangshun Tay 6d31fba043
Use code block for CompLibrary props (#563) 2018-04-14 13:24:41 -07:00
Kaveh Khorram a9f8701456 Added HTML tables to documentation page to improve UX (#514) 2018-04-14 13:05:26 -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
Amy Lam 8e2717cfae Cleanup code markdown in guides versioning (#545) 2018-04-11 00:04:07 -07:00
Joel Marcey bc3eef1b00
Update siteConfig example and docs (#544) 2018-04-10 10:00:04 -07:00
Yangshun Tay 099875a01a Display CompLibrary component in tabular format (#537) 2018-04-08 20:22:13 -07:00
Yangshun Tay 90d8e17158 Document className prop of GridBlock (#536) 2018-04-08 19:37:38 -07:00
Yangshun Tay 6500f9bacf More doc improvements (#532) 
* Generic doc improvements

* Convert to Markdown

* Remove whitespace

* More typo fixes
 2018-04-07 21:16:29 -07:00
Amy Lam c2cd169b64 Add alt tags to images for a11y (#529) 
- Add imageAlt to GridBlock
- Set alt equal to `user.caption` for mapped users
- Set alt equal to `post.author` for blog posts
- Update documentation
 2018-04-07 19:13:12 -07:00
Yangshun Tay 632ccfb8cd Fix typo and formatting in docs (#523) 2018-04-03 18:51:51 -10:00
Joel Marcey b6c6c2e4b8
colon in publishing example 2018-03-19 15:28:36 -07:00
Joel Marcey 1345504544
Publishing example indentation 2018-03-19 14:56:10 -07:00
b-morawiec 7080a49580 Typo -- "typeing" (#510) 2018-03-18 19:44:55 -07:00
Joel Marcey ad94258334
Discuss how to update Docusaurus 2018-03-16 12:55:08 -07:00
Joel Marcey f41b207333
Update CircleCI info 
Show how you can make it so CircleCI only runs when a commit is directly made to the `master` branch.
 2018-03-16 12:38:19 -07:00
Joel Marcey e798618ed2
Document node and yarn requirements. 2018-03-15 07:21:51 -07:00
Joel Marcey ce4d2f02b2
Add link to Facebook Pixel page 2018-03-14 18:05:17 -07:00
Pablo Estevez 508090377e Add Facebook Pixel ID setting (#507) 2018-03-14 18:01:23 -07:00
Joel Marcey 7c0651649c
Docs for secondary navigation 2018-03-12 17:16:06 -07:00
Joel Marcey d2f414c5d3
Add more docs for Algolia 2018-03-12 16:49:21 -07:00
Joel Marcey 6fe7621d05
Update headers in search docs 2018-03-12 16:30:30 -07:00
Joel Marcey f1893d5fea
Add secondary, page-specific navigation documentation (#498) 
And enable for docusaurus.io
 2018-03-12 16:27:37 -07:00
ashley teoh 7647ba3484 Updating documentation for CircleCI 2.0 (#491) 2018-03-08 12:45:57 -08:00
Joel Marcey 1add5dcbb2
Update translation docs 
Do not integrate `CROWDIN` variables within `package.json`
 2018-03-08 11:45:34 -08:00
Joel Marcey e48b6bbf66
Rearrange and provide more information for translations 2018-03-08 11:10:47 -08:00
Miralem Drek a8d7299ef2 Add `ogImage` to site-config docs (#487) 
Fixes #451
 2018-03-07 13:10:32 -08:00
Elian Ibaj 48ee457ec9 Add active link classes to site navigation menu (#463) 2018-03-04 08:53:31 -08:00
Joel Marcey f093790947
Add `blogSidebarCount` to the site config Docs (#480) 2018-02-28 16:32:59 -08:00
Justin Musgrove f79cfaa3a1 Fix broken link to site-config (#453) 2018-02-16 20:59:34 -08:00
Joel Marcey 9931ed86d2
A bit more clarifcation on the install and prep pages (#446) 2018-02-12 18:13:26 -08:00
Agastya Darma c8781bedce Move verifying Installation section to Installation doc (#435) 2018-02-12 18:04:17 -08: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
Ozan Araz 0da690db57 Organize siteConfig.js options documentation page better #436 (#437) 2018-02-06 08:03:50 -08:00
Joel Marcey 6dc282221a
Clarify publishing to a user or organization page (#434) 2018-02-03 19:03:34 -08:00
Eric Nakagawa dfb70e1829 Allow controlling number of blog posts in Recent Blogs sidebar. (#432) 
New feature. Allow controlling number of blog posts in Recent Blogs sidebar. Can have qty or ALL.
 2018-02-02 08:11:51 -08:00
Joel Marcey 62893dfe28
Add some more information around wrapPagesHTML (#426) 2018-01-31 19:53:50 -08:00
Joel Marcey edbb869e26
Add more details on configurable fonts (#409) 2018-01-21 20:10:04 -08:00
jonathan-cowling a241a46669 Make font-family as configurable parameter(#220) (#294) 
We look for fonts object within siteConfig.js
 2018-01-21 19:54:52 -08:00
Hayden Evans e0704d0f55 Correct typo in getting-started-installation.md (#405) 
Change 
> Docusaurus was designed from the ground up to be easily installed and used to get your website up **an** running quickly. 
to 
> Docusaurus was designed from the ground up to be easily installed and used to get your website up **and** running quickly.
 2018-01-19 18:56:04 -08:00
Joel Marcey 1d967a941c
Add section on referencing documents (#394) 
Closes #240
 2018-01-11 16:36:56 -08:00
Cheng Lou 00270c26a7 i18n: use zh-TW and zh-CN over zh-Hant and zh-Hans (#377) 
Both crowdin and docsearch i18n configs use TW and CN over Hant and Hans. This should reduce some config confusions.
cc @ericnakagawa. Also, apparently you're working on algolia search i18n?
 2018-01-11 15:40:53 -08:00
Filip Danić 65085b1337 document changes from PR #206 (as per issue #212) (#380) 2018-01-08 08:22:46 -08:00
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