Commit graph

310 commits

Author SHA1 Message Date
Sylvain Pace
34e664ac27
docs(v2): add mention on DocSearch when you run the crawler on your own (#2809) 2020-05-26 01:09:22 +08:00
Rajiv Singh
5a4a2d361f
docs: fix getting-started-publishing.md (#2747) 2020-05-14 14:19:30 +08:00
Reece Dunham
04a420d68f
refactor(v2): enhance CLI experience (#2556)
Signed-off-by: Reece Dunham <me@rdil.rocks>
2020-04-08 12:57:10 +08:00
jartuso
d06ab640ff
docs(v1): fix Windows instructions for GitHub Pages publishing (#2307)
additional space after GIT_USER=<GIT_USER> && was throwing errors on windows
2020-02-21 09:46:13 +08:00
Ondřej Nepožitek
8d804c662c
docs: update windows deploy command (#2281) 2020-02-16 21:42:41 +08:00
Hanseung Yoo
9b93416e53
Fix node.js version typo for compatible (#2264) 2020-02-02 23:25:55 +03:00
Yangshun Tay
19acc44d81
docs: promote Docusaurus 2 usage (#2126) 2019-12-15 17:49:25 +08:00
Yangshun Tay
2fcb81596b
docs: mention about moving docs directory into website (#2103) 2019-12-08 20:35:22 -08:00
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
Eric Carboni
b027db1b34 docs(v1): remove exclusive language (#1961)
* Initial commit to replace easy, easily, simple, just, of course

* Revert ordered list change
2019-11-11 14:06:54 -08:00
Dylan Myers
f853171791 docs(v2): add windows batch instructions for publishing to gh pages (#1914)
* docs: add windows batch instructions for publishing to gh pages

* docs: add windows batch instructions on the v2 website
2019-10-29 23:49:01 +07:00
Eric Ponvelle
5b3859d00b docs(v1): document how to include Google Fonts (#1852)
* Update api-site-config.md

Added a piece of text from the set-up guide to enable Google Fonts.

* Update api-site-config.md

* Update api-site-config.md
2019-10-20 12:22:35 -07: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
endiliey
1f6db3dd5b docs: update siteconfig 2019-10-17 10:53:56 +07:00
Eric Ponvelle
9e7e9670b3 docs: add more info on cleanUrl siteconfig (#1847)
* Update api-site-config.md

Added a clarification to the cleanUrl property to set it false if the users intend to use docusaurus only offline.

* Update api-site-config.md

Added the copyright information.

* Update api-site-config.md
2019-10-17 10:41:24 +07:00
Eric Ponvelle
3086bbf995 docs: document docker is optional (#1848)
* Update getting-started-installation.md

Added a note that Docker files were not needed, and they may be deleted.

* Update getting-started-installation.md

I'm really bad at adding copyright notices.

* Update getting-started-installation.md

Fixed a styling issue.

* Update getting-started-installation.md
2019-10-17 10:40:37 +07:00
Yangshun Tay
9f6460fde0 misc: facebook/Docusaurus -> facebook/docusaurus 2019-10-12 01:11:34 -07:00
Vincent
a5853241e1 docs: fix documented type for the cleanUrl option (#1775) 2019-09-13 12:01:23 -07:00
Jay Martin
7cab94a0c0 docs: add past versions to the tutorial (#1744)
* docs: add past versions to the tutorial

I changed "we" to "you" like the other sections of the tutorial.
I removed yarn from the code because `yarn version` didn't run on my Windows 10 system (see issue [1743](https://github.com/facebook/docusaurus/issues/1743)). 
I added headings for the current version, next version, and past versions.

* Update tutorial-version.md
2019-08-05 22:23:56 -07:00
Jay Martin
1c115d6ba4 docs: change the ID of the new documentation page (#1718)
* docs: add the repository to the localhost:3000 link

Fix two links on **[Create Pages](https://docusaurus.io/docs/en/next/tutorial-create-pages)**.

* docs: use the same start command on both pages

The start command in **[Scaffold the Site](https://docusaurus.io/docs/en/next/tutorial-create-new-site)** is "Run `npm start` or `yarn start.`" It will help new users to see the same start command again. A slightly different command will make new users think that something slightly different is happening.

* docs: change the ID of the new documentation page

The page ID "doc4" is already used by one of the downloaded pages, docs/exampledoc4.md, shown below: 

```
---
id: doc4
title: Other Document
---

this is another document
```

* docs: removed docusaurus-tutorial/ from the links
2019-08-04 12:42:55 -07:00
Jay Martin
8483012f36 docs: refer to Terminal and Git Bash (#1737)
I think the tutorial should tell Windows users to use Git Bash. Later in the tutorial is a command that worked in Git Bash, `publish-gh-pages`, but didn't work for me at the Windows command prompt.
2019-08-02 03:12:59 -07:00
Jay Martin
05858f0e50 docs: add an HTTPS example for publish-gh-pages (#1736)
* docs: add an HTTPS example for publish-gh-pages

I moved step 1 to step 2 so the terminal steps would be together. I added Git Bash, because `publish-gh-pages` worked for me in Git Bash but didn't work at the Windows command prompt. 

I added HTTPS to step 4 because, on my system, HTTPS worked for me but SSH didn't work. I changed <GIT_USER> to USERNAME and deleted the $ prompt, to be consistent with other examples in the tutorial.

* Update tutorial-publish-site.md
2019-08-02 02:40:25 -07:00
Nick Baroni
f1415b9080 docs: change separateCSS to separateCss (#1735)
The correct property, referenced on the "Custom Pages" docs page, is `separateCss`.
2019-08-01 12:57:19 -07:00
Jay Martin
ecc434a7fa docs: change example so USERNAME is only for GitHub (#1721)
I changed the `cd` example so it wouldn't say USERNAME like cloning example, which might mislead a new user.
2019-07-28 22:13:25 -07:00
Jay Martin
2e4663cf51 docs: revert a link to localhost:3000 (#1722)
This reverts commit e38373ac9b.
2019-07-28 22:12:22 -07:00
Jay Martin
e8cb415901 docs: fix the step numbering in "Scaffold the Site" (#1717)
Step 3 had a 2.
2019-07-27 15:03:38 -07:00
Jay Martin
e38373ac9b docs: add the repository name to the localhost:3000 link (#1715)
Change the link from `http://localhost:3000` to `http://localhost:3000/docusaurus-tutorial/`.
2019-07-26 19:13:23 -07:00
Jay Martin
9da4cc9640 move "cd to the repository" to "Scaffold the Site" (#1713)
The folder isn't important for the command `npm install --global docusaurus-init`. 

However, it is important to run `docusaurus-init` in the repository folder. The pull request moves the step to **[Scaffold the Site](https://docusaurus.io/docs/en/next/tutorial-create-new-site#scaffold-the-site).**
2019-07-27 09:54:33 +08:00
Jay Martin
25899bfb30 add "cd to the repository" to "Scaffold the Site" (#1714)
The step "`cd` to the directory of your local repository" was moved from **[Install the Docusaurus init command](https://docusaurus.io/docs/en/next/tutorial-setup#install-the-docusaurus-init-command)**. See the [previous pull request](https://github.com/facebook/docusaurus/pull/1713).
2019-07-27 09:52:25 +08:00
Jay Martin
a867503f20 docs: rearrange the info for install and check Node.js (#1712)
The description of `npm` fits better in the opening paragraph than in a numbered step. The note about version 8 fits better in the Check section than the Install section.
2019-07-26 11:07:48 -07:00
Wei Gao
9c1ba2c35c docs: document what should be in .gitignore (#1709)
* docs: explain .gitignore for generated site

* update changelog

* Update getting-started-preparation.md

* Update getting-started-preparation.md

* Update getting-started-preparation.md
2019-07-26 00:32:43 -07:00
Jay Martin
ab7e3589d0 docs: move a cd step to the start of the init task (#1710)
The `cd` step seems like the first step of "Install the Docusaurus init command," instead of the last step of "Create a GitHub repository and local clone."
2019-07-26 00:25:46 -07:00
Jay Martin
5f5cdb4aa8 docs: say that a page is a text file and link to editors (#1708)
A few extra details to help noobs.
2019-07-26 00:24:18 -07:00
Jay Martin
59b0f9cbac docs: add a cd step before clone in "Setting Up" (#1707)
* Add a cd step before clone in "Setting Up"

Add a `cd` step before clone in **[Setting Up](https://docusaurus.io/docs/en/next/tutorial-setup)**, add examples of `cd` in steps 5 and 7, and edit other steps.

* Update tutorial-setup.md
2019-07-25 13:27:01 -07:00
Jay Martin
c6b7c94367 docs: add "Install Git" to the "Setting Up" page (#1705)
* Add "Install Git" as a prerequisite

* Update tutorial-setup.md
2019-07-25 13:21:57 -07:00
Leo Lamprecht
f1a504e813 docs: suggest ZEIT Now for quick deployment of 2.0 (#1691)
* Suggest quick deployments for Docusaurus 2.0

* Sub heading

* Sub heading

* Sub heading

* Sub heading

* Update getting-started-publishing.md

* Update getting-started-publishing.md

* Update getting-started-publishing.md

* Update getting-started-publishing.md

* Update deployment.md

* Added to auto-deploy section

* Added to auto-deploy section

* Added to auto-deploy section

* Added to auto-deploy section

* Mention Git integration

* Update deployment.md

* Update deployment.md
2019-07-22 13:55:00 -07:00
Leo Lamprecht
96a970e5bf docs: suggest ZEIT Now for quick deployment (#1690)
* Suggest ZEIT Now for quick deployment

* Simpler heading

* Added 1.10.x

* Added 1.12.0

* Adedd 1.9.x
2019-07-22 10:55:53 -07:00
Anurag Goel
ee2050d612 docs: add Render hosting guide (#1615)
* Add Render deployment guide

* Add guide for Docusaurus 2

* Update guide for v2
2019-07-12 09:58:23 -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
Danny Hurlburt
6dbada2f08 docs: minor grammar fix in blog guide (#1614) 2019-06-19 10:49:38 -07:00
Danny Hurlburt
8ea6e5688f docs: fix reference to publishing steps (#1613) 2019-06-17 11:15:32 -07:00
Yangshun Tay
49cfdeb42b feat: make blog posts unlisted only in production 2019-06-15 10:32:43 -07:00
Joel Marcey
b2fe2a65c8 docs: add more clarity about markdown fields (#1589)
I wanted to enable superscript and subscripting to a v1 site. It wasn't quite clear how to do it. @yangshun helped me figure it out. So I thought I would document it.
2019-06-07 12:55:24 -07:00
Kent Williams
90138d52c2 docs: fix typo in guides-blog.md (#1553) 2019-06-03 18:30:22 -07:00
orangehat
fa4d72d969 docs: clean up language in create new site tutorial (#1537)
* Clean up tutorial language

Minor changes to clarify wording and grammar.

* Update tutorial-create-new-site.md
2019-05-31 08:47:05 -07:00
orangehat
43ff2b7670 docs: clarify wording/grammar for create pages tutorial (#1536)
* Clarify wording/grammar for tutorial

* Update tutorial-create-pages.md
2019-05-31 08:36:59 -07:00
SADIK KUZU
1282df063c docs: fix typo in website/pages folder structure (#1506) 2019-05-23 09:21:46 -07:00
Cole
0568ad4992 feat: allow different host through CLI flag (#1475)
* feat(core): use 0.0.0.0 for livereload address

* test(core): update server tests

* feat(cli): add host by command line flag

* test: revert test changes

* fix(core): update server to use custom host if supplied

* refactor: nits
2019-05-20 23:31:41 +07: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
TurekBot
be149e182f docs: clarify location of sidebars.json (#1472)
In #1468 we clarify where the `docs` folder is. 
Here, we make it clear where `sidebars.json` is.
2019-05-16 19:29:02 -07:00