Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/vcolesdev/vcolesdev-mydocs
Documentation for personal processes and the like. Contains troubleshooting notes, things I've learned, and more.
https://github.com/vcolesdev/vcolesdev-mydocs
autocomplete autocomplete-search flexsearch headlessui markdoc markdown nextjs react reactjs tailwindcss
Last synced: about 1 month ago
JSON representation
Documentation for personal processes and the like. Contains troubleshooting notes, things I've learned, and more.
- Host: GitHub
- URL: https://github.com/vcolesdev/vcolesdev-mydocs
- Owner: vcolesdev
- License: other
- Created: 2024-04-06T01:30:59.000Z (9 months ago)
- Default Branch: main
- Last Pushed: 2024-04-06T01:32:44.000Z (9 months ago)
- Last Synced: 2024-04-11T08:53:07.121Z (9 months ago)
- Topics: autocomplete, autocomplete-search, flexsearch, headlessui, markdoc, markdown, nextjs, react, reactjs, tailwindcss
- Language: TypeScript
- Homepage: https://vcdocs.netlify.app
- Size: 582 KB
- Stars: 0
- Watchers: 1
- 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