3pp-mirror/docusaurus
1
0
Fork 0
mirror of https://github.com/facebook/docusaurus.git synced 2025-05-09 07:07:25 +02:00
Code Issues Projects Releases Packages Wiki Activity
docusaurus/packages/docusaurus-init/templates/bootstrap
History
Sam Zhou cf5babd5c1
chore(v2): Add E2E test for yarn v2 (#3008) 
* chore(v2): Add E2E test for yarn v2

* Remove root node_modules to prevent them from accessible in e2e test

The purpose of e2e test is to ensure that the docusaurus inited website can stand on its own. The root node_modules remain accessible according to how node resolution works and it might interfere with the test. Remove them for safety.

* Add @mdx-js/react to docusaurus init templates
2020-07-01 12:06:03 +02:00
..
blog feat(v2): bootstrap theme blog post page (#2591) 2020-04-15 10:03:23 +08:00
docs misc: minor improvements for init templates (#2802) 2020-05-24 19:47:04 +08:00
src/pages chore(v2): mention about docs home page in init templates (#2763) 2020-05-18 13:14:06 +08:00
static feat(v2): add nojekyll file to static folder for all templates (#2902) 2020-06-08 09:45:57 +08:00
.gitignore feat(v2): bootstrap bootstrap (heh) theme, preset, template (#2557) 2020-04-09 12:58:01 +08:00
babel.config.js feat(v2): Allow configuring babel via babel.config.js (#2903) 2020-06-12 11:03:00 +08:00
docusaurus.config.js chore(v2): mention about docs home page in init templates (#2763) 2020-05-18 13:14:06 +08:00
package.json chore(v2): Add E2E test for yarn v2 (#3008) 2020-07-01 12:06:03 +02:00
README.md feat(v2): bootstrap bootstrap (heh) theme, preset, template (#2557) 2020-04-09 12:58:01 +08:00
sidebars.js feat(v2): bootstrap doc paginator (#2734) 2020-05-17 22:51:03 +08:00

README.md

Website

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

Installation

$ yarn

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.