Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/i-dream-of-ai/dreamofai-docs
Documentation for the I Dream of AI SaaS app
https://github.com/i-dream-of-ai/dreamofai-docs
ai documentation flexsearch idreamofai tailwindcss
Last synced: 11 days ago
JSON representation
Documentation for the I Dream of AI SaaS app
- Host: GitHub
- URL: https://github.com/i-dream-of-ai/dreamofai-docs
- Owner: i-dream-of-ai
- License: other
- Created: 2023-05-19T04:41:31.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2023-05-26T02:52:32.000Z (over 1 year ago)
- Last Synced: 2023-07-21T00:38:55.715Z (over 1 year ago)
- Topics: ai, documentation, flexsearch, idreamofai, tailwindcss
- Language: JavaScript
- Homepage: https://docs.idreamofai.com
- Size: 3.68 MB
- Stars: 0
- Watchers: 0
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE.md
Awesome Lists containing this project
README
# Syntax
Syntax is a [Tailwind UI](https://tailwindui.com) site template built using [Tailwind CSS](https://tailwindcss.com) and [Next.js](https://nextjs.org).
## 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.
## License
This site template is a commercial product and is licensed under the [Tailwind UI license](https://tailwindui.com/license).
## 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
- [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