Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/inkdropapp/api-docs
API documentation for Inkdrop
https://github.com/inkdropapp/api-docs
Last synced: 20 days ago
JSON representation
API documentation for Inkdrop
- Host: GitHub
- URL: https://github.com/inkdropapp/api-docs
- Owner: inkdropapp
- License: other
- Created: 2023-08-16T05:25:49.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2024-12-04T04:25:06.000Z (23 days ago)
- Last Synced: 2024-12-04T05:23:00.065Z (23 days ago)
- Language: MDX
- Homepage: https://developers.inkdrop.app/
- Size: 31.2 MB
- Stars: 17
- Watchers: 3
- Forks: 6
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE.md
Awesome Lists containing this project
README
# Inkdrop API documentation
https://developers.inkdrop.app/
## Stack
- [Tailwind CSS](https://tailwindcss.com)
- [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
- [FlexSearch](https://github.com/nextapps-de/flexsearch) - the official FlexSearch documentation
- [Zustand](https://docs.pmnd.rs/zustand/getting-started/introduction) - the official Zustand documentation
## 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.
## Global search
It 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/mdx/search.mjs` file.