https://github.com/gofr-dev/website

gofr.dev website application
https://github.com/gofr-dev/website

documentation gofr hacktoberfest react

Last synced: 3 months ago
JSON representation

gofr.dev website application

• Host: GitHub
• URL: https://github.com/gofr-dev/website
• Owner: gofr-dev
• License: mit
• Created: 2023-10-10T12:31:02.000Z (over 1 year ago)
• Default Branch: main
• Last Pushed: 2024-11-08T06:10:50.000Z (3 months ago)
• Last Synced: 2024-11-08T07:19:23.854Z (3 months ago)
• Topics: documentation, gofr, hacktoberfest, react
• Language: JavaScript
• Homepage: https://gofr.dev
• Size: 11.7 MB
• Stars: 15
• Watchers: 1
• Forks: 20
• Open Issues: 18
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
## Getting started

To get started with this site, first install the npm dependencies:

```bash

yarn install

```

Next, run the development server:

```bash

yarn 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.

## Learn more

To learn more about the technologies used in this site, 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

- [Markdoc](https://markdoc.io) - the official Markdoc 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