diff --git a/packages/docusaurus/templates/classic/README.md b/packages/docusaurus/templates/classic/README.md new file mode 100644 index 0000000000..71505291a8 --- /dev/null +++ b/packages/docusaurus/templates/classic/README.md @@ -0,0 +1,33 @@ +# 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= USE_SSH=1 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. diff --git a/packages/docusaurus/templates/classic/docusaurus.config.js b/packages/docusaurus/templates/classic/docusaurus.config.js index 8b7f0c4e89..76f1ff4701 100644 --- a/packages/docusaurus/templates/classic/docusaurus.config.js +++ b/packages/docusaurus/templates/classic/docusaurus.config.js @@ -11,6 +11,8 @@ module.exports = { url: 'https://your-docusaurus-test-site.com', baseUrl: '/', favicon: 'img/favicon.ico', + organizationName: 'facebook', // Usually your GitHub org/user name. + projectName: 'docusaurus', // Usually your repo name. themeConfig: { navbar: { title: 'My Site',