3pp-mirror/docusaurus
1
0
Fork 0
mirror of https://github.com/facebook/docusaurus.git synced 2025-05-01 19:27:48 +02:00
Code Issues Projects Releases Packages Wiki Activity
781 commits 46 branches 176 tags 872 MiB
Commit graph

170 commits

Author SHA1 Message Date
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
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