Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/egoist/funbook-old
I have a dream, to be a novelist someday.
https://github.com/egoist/funbook-old
blogs book docs markdown novel ssr vue website writing
Last synced: 12 days ago
JSON representation
I have a dream, to be a novelist someday.
- Host: GitHub
- URL: https://github.com/egoist/funbook-old
- Owner: egoist
- License: mit
- Created: 2017-04-13T13:19:56.000Z (over 7 years ago)
- Default Branch: master
- Last Pushed: 2021-12-25T14:24:58.000Z (almost 3 years ago)
- Last Synced: 2024-10-04T11:46:07.588Z (about 1 month ago)
- Topics: blogs, book, docs, markdown, novel, ssr, vue, website, writing
- Language: JavaScript
- Homepage: https://funbook.js.org
- Size: 854 KB
- Stars: 68
- Watchers: 3
- Forks: 5
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# funbook
[![NPM version](https://img.shields.io/npm/v/funbook.svg?style=flat)](https://npmjs.com/package/funbook) [![NPM downloads](https://img.shields.io/npm/dm/funbook.svg?style=flat)](https://npmjs.com/package/funbook) [![CircleCI](https://circleci.com/gh/egoist/funbook/tree/master.svg?style=shield&circle-token=a7f1239868460a608d25e9d2c7644a4fb3532953)](https://circleci.com/gh/egoist/funbook/tree/master) [![donate](https://img.shields.io/badge/$-donate-ff69b4.svg?maxAge=2592000&style=flat)](https://github.com/egoist/donate)
**FunBook** is a framework for building static or universal website, it's perfect for writing books, novels, docs and blogs.
## Install
```bash
yarn add funbook
# or
npm install --save funbook
```CDN: [JS](https://unpkg.com/funbook/dist/funbook.js) / [CSS](https://unpkg.com/funbook/dist/funbook.css)
## Support
[Documentation](https://funbook.js.org)
## Projects using FunBook
- [FunBook documentation](https://funbook.js.org) ([source](https://github.com/egoist/funbook/tree/master/docs))
- Feel free to add yours here ๐## Development
```bash
# Run example
yarn dev
```## 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## Author
**funbook** ยฉ [egoist](https://github.com/egoist), Released under the [MIT](./LICENSE) License.
Authored and maintained by egoist with help from contributors ([list](https://github.com/egoist/funbook/contributors)).> [egoistian.com](https://egoistian.com) ยท GitHub [@egoist](https://github.com/egoist) ยท Twitter [@rem_rin_rin](https://twitter.com/rem_rin_rin)