https://github.com/sylhare/docusaurus
To test docusaurus
https://github.com/sylhare/docusaurus
documentation docusaurus experiment typescript
Last synced: 2 months ago
JSON representation
To test docusaurus
- Host: GitHub
- URL: https://github.com/sylhare/docusaurus
- Owner: sylhare
- Created: 2022-05-03T12:12:41.000Z (about 4 years ago)
- Default Branch: main
- Last Pushed: 2022-05-11T13:51:51.000Z (about 4 years ago)
- Last Synced: 2025-06-11T14:59:54.464Z (about 1 year ago)
- Topics: documentation, docusaurus, experiment, typescript
- Language: JavaScript
- Homepage: https://sylhare.github.io/Docusaurus/
- Size: 896 KB
- Stars: 1
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Docusaurus
To test docusaurus
## Get started
```bash
# create website
npx create-docusaurus@latest my-website classic --typescript
# Install for typescript
npm install --save-dev typescript @docusaurus/module-type-aliases @tsconfig/docusaurus
# Install base plugins
npm install --save @docusaurus/plugin-content-blog
npm install --save @docusaurus/plugin-content-docs
npm install --save @docusaurus/theme-live-codeblock # code highlighting
npm install --save docusaurus-lunr-search # search
# Swizzle
npm run swizzle @docusaurus/theme-classic -- --typescript
```
## How to run
- `npm start`: Starts the development server.
- `npm run build`: Bundles your website into static files for production.
- `npm run serve`: Serves the built website locally.
- `npm deploy`: Publishes the website to GitHub pages.
## Useful links
- Docusaurus test site: https://docusaurus.io/tests/docs/category/tests
- Docusaurus plugins: https://docusaurus.io/docs/advanced/plugins
- Docusaurus Client API: https://docusaurus.io/docs/docusaurus-core#link
- Infima (Docusaurus theme): https://infima.dev/docs/components/badge