Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/golemfactory/golem-docs
https://github.com/golemfactory/golem-docs
golem
Last synced: 3 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/golemfactory/golem-docs
- Owner: golemfactory
- License: other
- Created: 2023-02-09T09:15:37.000Z (almost 2 years ago)
- Default Branch: master
- Last Pushed: 2024-04-13T00:05:45.000Z (8 months ago)
- Last Synced: 2024-04-14T16:14:54.527Z (8 months ago)
- Topics: golem
- Language: JavaScript
- Homepage: https://docs.golem.network
- Size: 47.9 MB
- Stars: 5
- Watchers: 5
- Forks: 5
- Open Issues: 12
-
Metadata Files:
- Readme: README.md
- License: LICENSE.md
Awesome Lists containing this project
README
## Getting started
To get started with this template, first install the npm dependencies:
```bash
npm install
```
Next, run the development server:
```bash
npm run dev
```
Finally, open [http://localhost:3000](http://localhost:3000) in your browser to view the website.
## Customizing
You can start editing this template by modifying the files in the `/src` folder. The site will auto-update as you edit these files.
## Global search
This template includes a global search that's powered by the [FlexSearch](https://github.com/nextapps-de/flexsearch) library. It's available by clicking the search input or by using the `⌘K` shortcut.
This feature requires no configuration, and works out of the box by automatically scanning your documentation pages to build its index. You can adjust the search parameters by editing the `/src/markdoc/search.mjs` file.