https://github.com/graphops/docs
GraphOps Documentation
https://github.com/graphops/docs
documentation graph-protocol graphops indexing
Last synced: 13 days ago
JSON representation
GraphOps Documentation
- Host: GitHub
- URL: https://github.com/graphops/docs
- Owner: graphops
- Created: 2022-08-15T20:26:48.000Z (almost 4 years ago)
- Default Branch: main
- Last Pushed: 2024-04-10T16:21:55.000Z (about 2 years ago)
- Last Synced: 2024-04-11T06:38:08.400Z (about 2 years ago)
- Topics: documentation, graph-protocol, graphops, indexing
- Language: JavaScript
- Homepage: https://docs.graphops.xyz
- Size: 12.8 MB
- Stars: 1
- Watchers: 1
- Forks: 2
- Open Issues: 7
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# GraphOps Documentation
## Quickstart
This website is built using [Docusaurus 2](https://docusaurus.io/), 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.
### Translate your site
Let's translate `docs/intro.md` to French.
#### Configure i18n
Modify `docusaurus.config.js` to add support for the `fr` locale:
```js title="docusaurus.config.js"
module.exports = {
i18n: {
defaultLocale: "en",
locales: ["en", "fr"],
},
};
```
#### Translate a doc
Copy the `docs/intro.md` file to the `i18n/fr` folder:
```bash
mkdir -p i18n/fr/docusaurus-plugin-content-docs/current/
cp docs/intro.md i18n/fr/docusaurus-plugin-content-docs/current/intro.md
```
Translate `i18n/fr/docusaurus-plugin-content-docs/current/intro.md` in French.
#### Start your localized site
Start your site on the French locale:
```bash
npm run start -- --locale fr
```
Your localized site is accessible at `http://localhost:3000/fr/` and the `Getting Started` page is translated.
:::caution
In development, you can only use one locale at a same time.
:::
#### Add a Locale Dropdown
To navigate seamlessly across languages, add a locale dropdown.
Modify the `docusaurus.config.js` file:
```js title="docusaurus.config.js"
module.exports = {
themeConfig: {
navbar: {
items: [
// highlight-start
{
type: "localeDropdown",
},
// highlight-end
],
},
},
};
```
The locale dropdown now appears in your navbar:
#### Build your localized site
Build your site for a specific locale:
```bash
npm run build -- --locale fr
```
Or build your site to include all the locales at once:
```bash
npm run build
```
## Notes/Bugs/Gotchas
Configure a documentation page's extra details with these [metadata fields](https://docusaurus.io/docs/api/plugins/@docusaurus/plugin-content-docs#markdown-frontmatter).