3pp-mirror/docusaurus
1
0
Fork 0
mirror of https://github.com/facebook/docusaurus.git synced 2025-08-02 08:19:07 +02:00
Code Issues Projects Releases Packages Wiki Activity
1769 commits 47 branches 178 tags 991 MiB
Commit graph

1769 commits

This branch
This branch
All branches
Author SHA1 Message Date
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
Endi
d6d113b1df
docs(v2): search - algolia and custom (#1734) 
* docs(v2): search - algolia and custom

* revisions
 2019-08-02 11:11:32 +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
Eran
b7f72946b0 docs: add Overwolf to users (#1728) 
* Update users.js

adding our overwolf project

* Add files via upload

add the Overwolf logo file
 2019-08-01 08:42:33 -07:00
Endi
ca3ae5ea96
chore: upgrade deps (#1733) 2019-08-01 19:14:12 +07:00
Sajo8
9e0d447399 docs: add TurtleCoin to users (#1730) 
* Add TurtleCoin to users

* Fix missing comma
 2019-07-31 01:24:41 -07:00
Wei Gao
2ebfc94ccb chore(v2): typos (#1726) 2019-07-29 19:13:59 -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
Wei Gao
4344b1a87d
docs(v2): deploy to netlify (#1719) 2019-07-28 16:48:24 +08: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
陈杨文
95ace0e4eb feat(v2): blog support date front matter (#1702) 
* feat(v2): blog support date front matter

* feat(v2): blog support date front matter

* feat(v2): blog support date front matter

* feat(v2): blog support date front matter

* Update CHANGELOG-2.x.md
 2019-07-27 18:03:14 +07:00
陈杨文
d17a1ea9e3 feat(v2): truncate marker as blog option (#1706) 
* feat(v2): allowed more as truncate marker

* feat(v2): blog support truncateMarker option

* feat(v2): blog support truncateMarker option
 2019-07-27 16:07:26 +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
endiliey
b5ee72a26a chore: download only enabled languages translation files 2019-07-26 23:07:04 +07:00
Endi
7ce6edc1b1
feat(v2): disable optimization.removeAvailableModules for webpack performance (#1711) 2019-07-26 22:42:03 +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
Wei Gao
f4f458460c docs(v2) themes (#1645) 
* More prep

* rename xxx-api to api-xxx

* move content around for plugins and themes

* wip docs: using themes

* docs(v2): tweak using plugins

* docs(v2): list official themes in docs

* docs(v2): advanced themes

* wip notes for lifecycle apis

* resolve PR review discussions

* lower case "theme"

* better intro for using themes

* add a simple README to @docusaurus/theme-classic

* remove list of components from theme classic README and replace with link to directory
 2019-07-26 12:00:40 +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
Wei Gao
162bfc43f8 docs(v2): contributing for v2 (#1700) 
* docs(v2): contributing for v2

* remove link to docs
 2019-07-25 16:23:01 +07:00
endiliey
41126fed12 v2.0.0-alpha.24 2019-07-24 15:55:28 +07:00
Endi
71aefbcddc
chore(v2): make feedback page accessible, not 404 (#1695) 
* chore(v2): make feedback page accessible, not 404

* hack
 2019-07-24 00:28:12 +07:00
Endi
8b60e93bcb
refactor(v2): remove unused metadata for pages (#1694) 
* refactor(v2): remove unused metadata for pages

* changelog
 2019-07-23 23:23:21 +07:00
Endi
1c59b5bc1c
chore(v2): upgrade deps and add missing docs on docusaurus config (#1693) 
* chore(v2): upgrade deps and add missing docs on docusaurus config

* review
 2019-07-23 23:06:15 +07:00
Wei Gao
f2864e0a91
docs(v2): analytics (#1678) 
* docs(v2): analytics

* docs(v2): rework analytics docs

* fix broken link
 2019-07-23 14:31:59 +08:00
Yangshun Tay
a684806a0f fix(v2): do not reveal environment file path (#1692) 
* fix(v2): do not reveal environment file path

* changelog

* fix broken markdown linking
 2019-07-23 13:12:21 +07:00
Endi
84b2270039
feat(v2): allow custom heading component (#1687) 
* feat(v2): allow custom heading component

* changelog
 2019-07-23 12:13:47 +07:00
Endi
6287739bec feat(v2): shorter chunk naming for pages (#1688) 
* refactor(v2): dont show absolute path for pages chunk/source naming

* test n changelog
 2019-07-22 15:53:29 -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
Endi
55ef751f26 feat(v2): use contenthash instead of chunkhash for longterm caching (#1686) 
* feat(v2): use contenthash instead of chunkhash for longterm caching

* changelog
 2019-07-21 10:11:39 -07:00
Endi
779c847a86
chore: disable low % translated language and fold docs <= 1.9.x (#1685) 
* disable low % translated language and fold docs <= 1.9.x

* tweak

* tweak
 2019-07-21 15:23:35 +07:00
Chen Hui Jing
bd72aacfe8 fix: content aligning breaks at IE11 (#1684) 2019-07-20 21:48:34 -07:00
endiliey
f37269aaad v2.0.0-alpha.23 2019-07-21 11:18:03 +07:00
Endi
71283dc7df
fix(v2): docusaurus route config generation for empty path (#1683) 
* fix(v2): route config does not acceptempty string

* test snapshot

* add test

* changelog
 2019-07-21 11:14:14 +07:00
Wei Gao
2a1eb365fd
docs(v2): SEO (#1677) 
* docs(v2): SEO

* docs(v2): add section on customized SEO

* remove unnecessary comment

* docs(v2): separate SEO doc and fix typos
 2019-07-21 00:03:05 +08:00
endiliey
ae620cd530 v2.0.0-alpha.22 2019-07-20 18:31:41 +07:00
Yangshun Tay
6f0d858b4f chore(v2): shift v2 CHANGELOG and update classic template (#1682) 
* chore(v2): shift v2 CHANGELOG and update classic template

* changelog
 2019-07-20 18:08:25 +07:00
陈杨文
ff105bf774 feat(v2): add support for front matter id in blog (#1666) 2019-07-20 03:40:51 -07:00
Wei Gao
05b28b5520 v1.12.0 (#1679) 
* v1.12.0

* Add compare version link for v1.12

* Update version numbers for v1.12

* cut new docs

* changelog
 2019-07-20 17:21:47 +07:00
Endi
1f0f3e130b
feat(v2): ⚡️ faster and lighter bundle size (optimization) (#1681) 
* feat(v2):⚡️  fasterr and lighter bundle size optimization

* lint

* nits
 2019-07-20 16:55:24 +07:00
Endi
7f5c1ef581
refactor(v2): use forked lqip-loader for performance (#1680) 2019-07-20 15:23:01 +07:00