https://github.com/newtonproject/docs
https://github.com/newtonproject/docs
Last synced: 3 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/newtonproject/docs
- Owner: newtonproject
- Created: 2021-09-11T11:47:41.000Z (almost 4 years ago)
- Default Branch: main
- Last Pushed: 2025-02-05T12:12:06.000Z (5 months ago)
- Last Synced: 2025-02-05T13:23:00.925Z (5 months ago)
- Language: SCSS
- Homepage: https://docs.newtonproject.org
- Size: 390 KB
- Stars: 0
- Watchers: 5
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Newton Docs
This is a **pre-configured Docusaurus starter template** for i18n docs & posts using Docusaurus `v2.0.0-beta.18`, Typescript, Sass, Local Search etc.
A live demo build directly from this repository is deployed on [docusaurus-boilerplate.vercel.app](https://docusaurus-boilerplate.vercel.app) which means you can start a docs site exactly like the demo out of the box.
## Features
- Out of the box pre-configed Docusaurus Site for docs, pages and blogs.
- i18n pre-configed.
- Local search using [docusaurus-search-local](https://github.com/cmfcmf/docusaurus-search-local).
- Sass integration.
- etc.
## Documentation
This Template Is Currently `Working In Progress`
*do not fork this repo unless you are going to contribute, this WIP is under a lot of force pushes*
just `clone` or [Use This Template](https://github.com/arisac/docusaurus-starter-boilerplate-docs-only/generate)
### Quick start a local site
Multi-languages & local search are not available for dev server, so just start a build server using:
```bash
yarn
yarn build
npm run serve
```
### Start Config Your Site
Visit your started local site http://localhost:3000 or online version https://docusaurus-boilerplate.vercel.app to view the full documentation.