https://github.com/n0-computer/iroh.computer
iroh website
https://github.com/n0-computer/iroh.computer
Last synced: about 1 year ago
JSON representation
iroh website
- Host: GitHub
- URL: https://github.com/n0-computer/iroh.computer
- Owner: n0-computer
- License: other
- Created: 2022-09-16T16:19:17.000Z (over 3 years ago)
- Default Branch: main
- Last Pushed: 2023-12-19T01:21:18.000Z (over 2 years ago)
- Last Synced: 2023-12-19T08:08:14.175Z (over 2 years ago)
- Language: JavaScript
- Homepage: https://iroh.computer
- Size: 13 MB
- Stars: 8
- Watchers: 6
- Forks: 9
- Open Issues: 9
-
Metadata Files:
- Readme: readme.md
- License: LICENSE
Awesome Lists containing this project
README
# iroh.computer
The docs theme is based on the [protocol](https://protocol.tailwindui.com) tailwind theme, with a bunch of modifications. Protocol is a [Tailwind UI](https://tailwindui.com) site template built using [Tailwind CSS](https://tailwindcss.com) and [Next.js](https://nextjs.org).
## Getting started
You'll need [`node`](https://nodejs.org/) to run locally. 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.
## Editing docs content
Our docs are generated. Use the following steps to make adjustments to the content and update the website to match:
- make your edits to the documentation in the `api-code-examples/api.mjs` file
- cd into the `scripts` folder
- run `npm install` if you have not run it in this folder previously
- run `node generate-api-pages.js` to generate the doc files for the website
### Style / grammar guide
Follow the style that has already been layed out. But as a general rule of thumb, follow normal English punctuation, but favor brevity over proper grammar. In other words, use capital letters at the start of sentences, and end them with a period, but sentences can be fragments if that gets the point across quicker.
## Learn more
To learn more about the technologies used in this site template, see the following resources:
- [Tailwind CSS](https://tailwindcss.com/docs) - the official Tailwind CSS documentation
- [Next.js](https://nextjs.org/docs) - the official Next.js documentation
- [Headless UI](https://headlessui.dev) - the official Headless UI documentation
- [Framer Motion](https://www.framer.com/docs/) - the official Framer Motion documentation
- [MDX](https://mdxjs.com/) - the official MDX documentation
- [Algolia Autocomplete](https://www.algolia.com/doc/ui-libraries/autocomplete/introduction/what-is-autocomplete/) - the official Algolia Autocomplete documentation
- [FlexSearch](https://github.com/nextapps-de/flexsearch) - the official FlexSearch documentation
- [Zustand](https://docs.pmnd.rs/zustand/getting-started/introduction) - the official Zustand documentation