Commit graph

195 commits

Author SHA1 Message Date
Andrey Rublev
850e3003ca [docs] add note about babel cache to upgrade guide (#778)
for details see https://github.com/facebook/Docusaurus/issues/759
2018-06-15 10:32:35 -07:00
Jonathan Ingram
58fba70dea Add config option for setting title of the blog sidebar (#770)
* Allow controlling the title of the blog sidebar

* Update guides-blog.md
2018-06-15 00:08:34 -07:00
=^._.^=
62a2c7c1a5 Add option to disable live reload server during development (#766)
* add option to disable live reload server

* change live to watch, fix incorrect argument parsing code

* Update api-commands.md
2018-06-14 23:51:03 -07:00
Joel Marcey
608e2c85a2
Move custom translation strings to its own file (#775) 2018-06-14 17:25:29 -07:00
Gustavo Henke
fd9a3ffb6d Cross repo publishing (#764) 2018-06-14 16:03:37 -07:00
Joel Marcey
de8da1ca54
Better bash formatting for updating Docusaurus 2018-06-11 17:46:58 -07:00
Joel Marcey
7281c5632b
More details on updating Docusaurus for a site 2018-06-11 16:53:04 -07:00
Joel Marcey
902db36edb
Fix broken search guide formatting 2018-06-10 17:37:43 -07:00
Tim Kelly
976df54419 Add back information about extra search options (#756)
I added back information about extra search options for Algolia. A previous commit removed the section about extra search options, but it appears the information might actually be useful.
2018-06-10 17:32:04 -07:00
Endilie Yacop Sucipto
c47af6be4b Enable custom meta description for custom pages (#752) 2018-06-10 09:35:30 -07:00
Yangshun Tay
18c01327a3 Reformat, proofread and tidy up docs (#749) 2018-06-10 08:02:04 -07:00
Yangshun Tay
ffe782a669
Remove outdated restriction for docs nesting (#746) 2018-06-10 01:21:06 -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
vacarsu
16da2fdbf6 Update getting-started-installation.md (#742)
* Update getting-started-installation.md

Add minimum yarn version

* Add a period

* Update getting-started-installation.md
2018-06-08 17:09:34 -07:00
Endilie Yacop Sucipto
d04b3ca87b Enable sub-directories in docs/ (#705) 2018-06-07 07:41:28 -07:00
Endilie Yacop Sucipto
31f0c27f81 Enable clean / extension-less url (#677) 2018-06-06 13:37:49 -07:00
Lespagnol Rémy
aee255219b Add a scroll to top button siteConfig option (#723) 2018-06-06 12:34:32 -07:00
ranolf
2bd9a148c1 Support publishing to Github Enterprise hosting (#689)
* Added support for Github Enterprise GH Pages

* Fixed with prettier output

* Tweak

* Tweak

* Tweak
2018-06-02 15:59:29 -07:00
Endilie Yacop Sucipto
e91e648844 Add Travis CI guide (#721) 2018-06-02 11:25:13 -07:00
Endilie Yacop Sucipto
fa20c93d5c Add documentation for setting title of custom pages (#712)
* add customtitle for page doc

* Update api-pages.md

* Update api-pages.md
2018-05-30 22:16:50 -07:00
Dongwoo Gim
5272944626 Fix typo error on Tips & Tricks (#708) 2018-05-28 21:17:30 -07:00
Yangshun Tay
454e3d359f
Update directory tree (#696) 2018-05-23 21:01:33 -07:00
Sébastien Loix
d14d3c2092 Add documentation about using development server behind a proxy #603 (#688)
* Add documentation to launch development server behind a proxy #603

* Update getting-started-installation.md

* Update getting-started-installation.md
2018-05-22 22:14:24 -07:00
Endilie Yacop Sucipto
aae106c018 Enable Facebook comments on blog posts (#673)
* Enable comment on blog post

* adjust css

* Tweak
2018-05-19 09:26:57 -07:00
Endilie Yacop Sucipto
f8521c2fe1 Enhance footer with Facebook and Twitter buttons (#666)
* enhance footer with social media buttons

* Update api-site-config.md

* Update Footer.js

* fix minor issue on social-footer

* update facebookAppId description in api-site-config

* rm heading & pad footer social button

* Update api-site-config.md
2018-05-17 21:26:06 -07:00
Endilie Yacop Sucipto
c730bc7bb7 Improve publishing guide on Github Pages (#664)
Docusaurus docs is confusing, it should be https://facebook.github.io/Docusaurus when referring to GitHub Pages URL, not the custom domain at https://docusaurus.io/
2018-05-15 18:55:42 -07:00
Joel Marcey
f315d02e58
Circle doc updates 2018-05-11 18:30:59 -07:00
Yangshun Tay
87a2392d6e Make CLI docs futureproof (#660) 2018-05-10 20:52:04 -07:00
Ahmad Alfy
ab6bab9f8d [Feature] Introducing image compression using imagemin (#654)
* Introduce imagemin for compressing images

* Replace original images with the optimized ones

* Add imagemin-svgo to dependencies

* Remove console statement, replace let with const

* Replace let with const

* Add --skip-image-compression

* Run Prettier
2018-05-09 16:59:36 -07:00
Erin Teo
5771549e75 Rename latestVersion to defaultVersion (#639)
* Rename lastVersion to defaultVersion

* Added defaultVersionShown to site-config doc

* Remove defaultVersionShown from siteConfig

* Update api-site-config.md
2018-05-05 17:24:39 -07:00
Matías Olivera
34d86f760b Fix assets directory path in "Tips & Tricks" (#630) 2018-05-03 08:16:15 -07:00
SoonaMata
0d7af296b5 Update documentation, add link for SSH key (#627)
Came across issue with SSH and added the link to help other beginners who may have the same issue.
2018-05-02 14:06:56 -07:00
Tim Carry
5afc0b0a1c Simplify DocSearch documentation (#624)
* Simplifying DocSearch documentation

I slightly rewrote the DocSearch documentation. The main three points are:

- I explained a bit more how DocSearch works (trying to explain that it's an external service that requires the website to be online)
- I removed mentions to the _search_ API key as in that case, it's always a _search_ (as opposed to _admin_) API key that is used
- I removed the part about faceting on the version. I thought it was confusing as without a specific UI to display the faceting, this won't do much. To use it properly, one will need to dig more into layouts. I might submit a PR about that later, but as it was today I think it would just create confusing rather that adding value

Hope that helps :)

* Make links URLs inline
2018-05-02 08:27:17 -07:00
Amit Harlev
a7b65bb6f4 Incorrect file path for netlify publishing (#622)
I tried following the guide to publish my website on Netlify (on April 29, 2018), however it did not work until I changed the path to include "website/".
2018-04-29 14:13:17 -07:00
Fabrizio Ruggeri
976ae770b5 Allow Google Analytics to use gtag.js (#601)
* Moved google analytics script to head

The code now uses the new gtag script to track the website on google analytics.
The migration is explained [here](https://developers.google.com/analytics/devguides/collection/gtagjs/migration).
This will help to solve issues such as #375.
As indicated at https://support.google.com/analytics/answer/1008080
the analytics code must be placed in the head tag, so it is moved there.

* Add a boolean to use the new gtag library

* Update api-site-config.md
2018-04-29 10:44:11 -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
Yangshun Tay
327ef85770
Improve directory file tree (#614) 2018-04-27 22:47:14 -07:00
Darragh Grace
91897191b6 Adding info for Hosting Static HTML Pages due to recent css changes (#611)
Adding info for Hosting Static HTML Pages
2018-04-27 09:13:42 -07:00
Yangshun Tay
7ea0f5a8cf s/Github/GitHub (#608) 2018-04-26 09:43:47 -07:00
Joel Marcey
6d2462e84a Add docs for docs-based landing page
Fixes #459
2018-04-23 15:31:10 -07:00
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