3pp-mirror/docusaurus
1
0
Fork 0
mirror of https://github.com/facebook/docusaurus.git synced 2025-04-30 10:48:05 +02:00
Code Issues Projects Releases Packages Wiki Activity
Easy to maintain open source documentation websites.
5 commits 46 branches 176 tags 870 MiB
TypeScript 88.3%
HTML 5.9%
JavaScript 2.8%
CSS 2%
XSLT 0.8%
Find a file
Sébastien Lorber 61cd834f5b docs(v2): i18n doc + polish (#4014) 
* add some initial i18n doc

* i18n doc progress

* i18n tutorial progress

* i18n tutorial progress

* polish Crowdin docs

* i18n sidebar in guides

* polish crowdin doc

* update Crowdin doc a bit

* fix annoying relative link to global site resource in template (breaks i18n tutorial)

* template: use simpler export for homepage

* add markdown page example

* rename mdx.md to interactiveDoc.mdx

* update bootstrap/facebook templates too

* sync init template package scripts

* add slug frontmatter doc

* improve i18n doc

* complete i18n doc

* temporarily enable the localeDropdown

* doc typo

* improve the i18n doc

* Add Git i18n doc

* add missing "--" for npm run options (unfortunately they don't get stripped by npm2yarn, and are required foor npm)

* improve a bit the Crowdin doc
2021-01-19 17:26:31 +01:00
blog feat(v2): official CodeSandbox support (#3717) 2020-11-16 16:20:16 +01:00
docs feat(v2): core v2 i18n support + Docusaurus site Crowdin integration (#3325) 2020-11-26 12:16:46 +01:00
src docs(v2): i18n doc + polish (#4014) 2021-01-19 17:26:31 +01:00
static feat(v2): official CodeSandbox support (#3717) 2020-11-16 16:20:16 +01:00
.gitignore feat(v2): official CodeSandbox support (#3717) 2020-11-16 16:20:16 +01:00
babel.config.js feat(v2): official CodeSandbox support (#3717) 2020-11-16 16:20:16 +01:00
docusaurus.config.js chore(v2): Regen codesandbox templates + add template: "docusaurus" (#4063) 2021-01-19 16:13:14 +01:00
package.json chore(v2): Regen codesandbox templates + add template: "docusaurus" (#4063) 2021-01-19 16:13:14 +01:00
README.md feat(v2): official CodeSandbox support (#3717) 2020-11-16 16:20:16 +01:00
sandbox.config.json chore(v2): Regen codesandbox templates + add template: "docusaurus" (#4063) 2021-01-19 16:13:14 +01:00
sidebars.js feat(v2): official CodeSandbox support (#3717) 2020-11-16 16:20:16 +01:00
yarn.lock chore(v2): Regen codesandbox templates + add template: "docusaurus" (#4063) 2021-01-19 16:13:14 +01:00

README.md

Website

This website is built using Docusaurus 2, a modern static website generator.

Installation

yarn install

Local Development

yarn start

This command starts a local development server and open up a browser window. Most changes are reflected live without having to restart the server.

Build

yarn build

This command generates static content into the build directory and can be served using any static contents hosting service.

Deployment

GIT_USER=<Your GitHub username> USE_SSH=true yarn deploy

If you are using GitHub pages for hosting, this command is a convenient way to build the website and push to the gh-pages branch.