3pp-mirror/docusaurus
1
0
Fork 0
mirror of https://github.com/facebook/docusaurus.git synced 2025-08-02 16:29:47 +02:00
Code Issues Projects Releases Packages Wiki Activity
docusaurus/packages/docusaurus-init/templates/classic
History
iAmir 8f2d898f22
feat(v2): onBrokenMarkdownLinks config (#3658) 
* refactor(v2): move `reportMessage` from `core/src/server/utils` to `utils` package

* feat(v2): handle broken markdown links by using onBrokenLinks prop from siteconfig

* feat(v2): add a new site config prop called `onBrokenMarkdownLinks`

works like onBrokenLinks, but only for markdown links

* feat(v2): add `onBrokenMarkdownLinks` to API docs

* some changes regarding test issues after adding `onBrokenMarkdownLink`

* Update website/versioned_docs/version-2.0.0-alpha.66/api/docusaurus.config.js.md

Co-authored-by: Sébastien Lorber <slorber@users.noreply.github.com>
2020-10-31 18:04:56 +01:00
..
blog feat(v2): blog slug frontmatter (#3284) 2020-08-20 14:59:54 +02:00
docs fix(v2): deprecate docs homePageId in favor of frontmatter "slug: /" (#3228) 2020-08-06 18:31:50 +02:00
src fix(v2): bad template alt prop (#3258) 2020-08-11 13:34:33 +02:00
static feat(v2): add nojekyll file to static folder for all templates (#2902) 2020-06-08 09:45:57 +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(v2): onBrokenMarkdownLinks config (#3658) 2020-10-31 18:04:56 +01:00
gitignore misc(v2): nitpicky formatting 2019-12-04 00:55:52 -08:00
package.json chore(v2): prepare v2.0.0.alpha-66 release (#3608) 2020-10-19 19:44:26 +02:00
README.md fix(v2): Fix markdownlint rules on template init/README #3465 2020-09-29 12:23:06 +02:00
sidebars.js çhore(v2): revert changes 2020-05-13 13:32:04 -03: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.