https://github.com/2nthony/saika

✍️Effortless info-site, done right.
https://github.com/2nthony/saika

blog documentation docute gitbook markdown pluggable pr-welcome saika vercel vue zeit

Last synced: about 1 month ago
JSON representation

✍️Effortless info-site, done right.

• Host: GitHub
• URL: https://github.com/2nthony/saika
• Owner: 2nthony
• License: mit
• Created: 2019-07-15T04:35:49.000Z (over 5 years ago)
• Default Branch: master
• Last Pushed: 2023-12-15T17:39:46.000Z (11 months ago)
• Last Synced: 2024-09-28T17:23:08.834Z (about 2 months ago)
• Topics: blog, documentation, docute, gitbook, markdown, pluggable, pr-welcome, saika, vercel, vue, zeit
• Language: JavaScript
• Homepage: https://saika.vercel.app/
• Size: 1.98 MB
• Stars: 21
• Watchers: 1
• Forks: 2
• Open Issues: 26
• Metadata Files:
  • Readme: README.md
  • Funding: .github/FUNDING.yml
  • License: LICENSE

Awesome Lists containing this project

README

        
# Saika

[![NPM version](https://badgen.net/npm/v/saika?label=&color=cyan)](https://npmjs.com/package/saika) [![lerna](https://badgen.net/badge/maintained%20with/lerna/cc00ff)](https://lerna.js.org)

> Effortless info-site, done right.

Please consider starring the project to show your ❤️ and support.

## Features

- No build process, website generated on the fly.

- An elegant UI inspired by Vercel/design.

- Extensible plugin system, plenty of official and community themes and plugins.

- Powered by Markdown and Vue.

## Ecosystem

### Themes

| Project                                                 | Stauts                                               | Description                    |

| ------------------------------------------------------- | ---------------------------------------------------- | ------------------------------ |

| [docs](https://saika.vercel.app/#/theme/docs)           | ![](https://badgen.net/npm/v/@saika/theme-docs)      | Similar to Vercel's docs       |

| [portfolio](https://saika.vercel.app/#/theme/portfolio) | ![](https://badgen.net/npm/v/@saika/theme-portfolio) | Portfolio page with github api |

### Plugins

| Project                                                          | Stauts                                                | Description           |

| ---------------------------------------------------------------- | ----------------------------------------------------- | --------------------- |

| [google-analytics](https://saika.vercel.app/#/plugin/ga)         | ![](https://badgen.net/npm/v/@saika/google-analytics) | -                     |

| [mermaid](https://saika.vercel.app/#/plugin/mermaid)             | ![](https://badgen.net/npm/v/@saika/mermaid)          | Mermaid-js            |

| [plantuml](https://saika.vercel.app/#/plugin/plantuml)           | ![](https://badgen.net/npm/v/@saika/plantuml)         | PlantUML              |

| [github-corner](https://saika.vercel.app/#/plugin/github-corner) | ![](https://badgen.net/npm/v/@saika/github-corner)    | Badge for github repo |

| [disqus](https://github.com/2nthony/saika-plugin-disqus)         | ![](https://badgen.net/npm/v/saika-plugin-disqus)     | Disqus comment system |

## Documentation

- https://saika.vercel.app

## Contributing

1. Fork it!

2. Create your feature branch: `git checkout -b my-new-feature`

3. Commit your changes: `git commit -am 'Add some feature'`

4. Push to the branch: `git push origin my-new-feature`

5. Submit a pull request :D

## Credits

- [**Docute**](https://docute.org)

- [Vue.js](https://vuejs.org)

- [Vercel Design](https://vercel.com/design)

- [Vercel Docs](https://vercel.com/docs)

## Author

**Saika** © [2nthony](https://github.com/2nthony), Released under the [MIT](./LICENSE) License.

Authored and maintained by **2nthony** with help from contributors ([list](https://github.com/2nthony/saika/contributors)).

> GitHub [@2nthony](https://github.com/2nthony) · Twitter [@\_2nthony](https://twitter.com/_2nthony)