Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/dmijatovic/rsd-docusaurus-test
Testing docusaurus for rsd documentation
https://github.com/dmijatovic/rsd-docusaurus-test
Last synced: 10 days ago
JSON representation
Testing docusaurus for rsd documentation
- Host: GitHub
- URL: https://github.com/dmijatovic/rsd-docusaurus-test
- Owner: dmijatovic
- Created: 2023-09-12T17:05:40.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2023-09-14T15:00:25.000Z (over 1 year ago)
- Last Synced: 2024-11-13T16:54:10.520Z (2 months ago)
- Language: JavaScript
- Size: 11.5 MB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Website
This website is built using [Docusaurus 2](https://docusaurus.io/), a modern static website generator.
## Instructions
### Installation
```bash
npm install
```
### Local Development
```bash
npm 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.
### Adding new pages
The documentation has 2 main sections:
- Developers documentation: techinical documentation for developers who want to run their own instance of RSD
- Users documentation: the documentation about how to use RSD
To create new page create a new md file at the location where new page need to be added.
### Versioning
See [documentation for more details](https://docusaurus.io/docs/versioning)
```bash
npm run docusaurus docs:version 1.x.x
```
### Translations
See [documentation for more details](https://docusaurus.io/docs/i18n/tutorial)
```bash
# start
npm run start -- --locale en
# create translation files (metadata)
npm run write-translations -- --locale nl
# copy default markdown content into i18 location
```
### Build
```bash
npm build
```
This command generates static content into the `build` directory and can be served using any static contents hosting service.
### Deployment
The documentation is published in the separate repo. You need to have access to documentation repo to be able to publish.
The information about where documenation will be published is stored in docusaurus.config.js
```javascript
...
// Set the production url of your site here
url: 'https://dmijatovic.github.io/',
// Set the // pathname under which your site is served
// For GitHub pages deployment, it is often '//'
baseUrl: '/rsd-documentation/',
// GitHub pages deployment config.
// If you aren't using GitHub pages, you don't need these.
organizationName: 'dmijatovic', // Usually your GitHub org/user name.
projectName: 'rsd-documentation', // Usually your repo name.
deploymentBranch: 'main',
...
```
Using SSH:
```bash
# use npm script
npm run ssh:deploy
# use basic deploy script
USE_SSH=true npm run deploy
```
Not using SSH:
```bash
GIT_USER= npm run deploy
```