https://github.com/golemcloud/docs
Golem Cloud Documentation
https://github.com/golemcloud/docs
Last synced: 11 months ago
JSON representation
Golem Cloud Documentation
- Host: GitHub
- URL: https://github.com/golemcloud/docs
- Owner: golemcloud
- Created: 2023-10-30T18:08:41.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2025-05-10T18:48:35.000Z (about 1 year ago)
- Last Synced: 2025-05-10T19:33:02.320Z (about 1 year ago)
- Language: MDX
- Homepage: https://learn.golem.cloud
- Size: 1.35 MB
- Stars: 15
- Watchers: 10
- Forks: 15
- Open Issues: 15
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
## Getting Started
1. [Install Bun](https://bun.sh/docs/installation)
2. Install dependencies
`bun install`
3. Run the development server
`bun run dev`
4. Open http://localhost:3001 with your browser to see the result.
## Developing Guide
This docs site is built with [Nextra](https://nextra.site/)
## Adding a new page
Each docs page is created from a .mdx file. To add a new page, create a new .mdx file in the `pages` directory. The file name will be the URL path.
For example, `pages/docs/getting-started.mdx` will be available at `/docs/getting-started`.
### Changing page metadata
In order to change the page's title or placement on the left hand sidebar, you need to create a `_meta.json` file in the same directory as the .mdx file.
[Read more about Nextra's \_meta.json files](https://nextra.site/docs/guide/organize-files#_metajson).
[Read more about Nextra's docs theme](https://nextra.site/docs/docs-theme).
If we had a page `/pages/docs/getting-started.mdx`, we could add a `_meta.json` file to change the title and make it the first entry in the sidebar.
```json
{
"getting-started": {
"title": "Getting Started - Overview"
},
"other-page": "Other Page"
}
```
Note how the key in the json object matches the file name. This is how Nextra knows which page to apply the metadata to.
> If the value is a json object, you can set multiple parameters. If it's a string, it will just change the title.