3pp-mirror/docusaurus
1
0
Fork 0
mirror of https://github.com/facebook/docusaurus.git synced 2025-08-02 00:09:48 +02:00
Code Issues Projects Releases Packages Wiki Activity
docusaurus/packages/docusaurus-init/templates/facebook
History
Bharat Middha 09550b0535
feat: properly type-check the Docusaurus config of new sites (#5589) 
* fix: makes types DocusaurusConfig optional to match docs

* add UserDocusaurusConfig with required keys for user config

* convert UserDocusaurusConfig to use util type

* Docusaurus website config should be type-checked by CI + fix all existing issues

* add doc for config typechecking

* Update template configs for TS autocompletion

* fix last config typechecking bugs

* reapply prettier

* reapply prettier-docs

* Fix TS doc: add missing ()

* fix some docu plugin types

* add "const config" for simpler jsdoc annotation

Co-authored-by: slorber <lorber.sebastien@gmail.com>
2021-09-30 17:49:44 +02:00
..
src refactor(init): share common files between templates (#5315) 2021-08-10 16:26:59 +02:00
static/img refactor(init): share common files between templates (#5315) 2021-08-10 16:26:59 +02:00
.eslintrc.js chore(v2): migrate babel-eslint to @babel/eslint-parser (#4453) 2021-03-19 11:59:36 +01:00
.prettierignore
.prettierrc chore(v2): update Prettier config (#2542) 2020-04-05 23:51:47 +08:00
.stylelintrc.js fix(v2): improve stylelint copyright header rule (#2363) 2020-03-07 11:49:52 +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 feat: properly type-check the Docusaurus config of new sites (#5589) 2021-09-30 17:49:44 +02:00
gitignore
package.json chore: upgrade dependencies (#5608) 2021-09-24 16:36:41 +02:00
README.md docs(v2): fixed typos (#4560) 2021-04-05 18:42:41 +02:00
sidebars.js refactor(init): share common files between templates (#5315) 2021-08-10 16:26:59 +02: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 opens 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.

Continuous Integration

Some common defaults for linting/formatting have been set for you. If you integrate your project with an open source Continuous Integration system (e.g. Travis CI, CircleCI), you may check for issues using the following command.

$ yarn ci