Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/vuesence/vuesence-book
Minimalistic Vue.js based documentation system component
https://github.com/vuesence/vuesence-book
doc docs documentation documentation-tool markdown web-components
Last synced: 3 days ago
JSON representation
Minimalistic Vue.js based documentation system component
- Host: GitHub
- URL: https://github.com/vuesence/vuesence-book
- Owner: vuesence
- License: mit
- Created: 2020-04-26T08:33:50.000Z (almost 5 years ago)
- Default Branch: master
- Last Pushed: 2023-11-13T03:45:12.000Z (about 1 year ago)
- Last Synced: 2025-01-28T18:41:22.672Z (14 days ago)
- Topics: doc, docs, documentation, documentation-tool, markdown, web-components
- Language: Vue
- Homepage:
- Size: 3.33 MB
- Stars: 52
- Watchers: 5
- Forks: 6
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Vuesence Book
Minimalistic Vue.js based documentation system component
[](https://snyk.io/test/github/altrusl/vuesence-book)
[](https://dependabot.com)
# How to use
**Vuesence Book** can be used as a Vue component in a Vue.js project or stand-alone in a browser
## Node.js usage example
```bash
npm install @vuesence/book --save
```
```html
import VuesenceBook from "@vuesence/book";
export default {
name: "App",
components: {
VuesenceBook
}
};
@import './css/default.css';
/* @import './css/vuepress-style.css'; */
/* @import './css/google-style.css'; */
```
## Browser usage example
The **Vuesence Book** can be run as a stand-alone web component in the browser. `Vue` and `@vuesence/book` packages should be loaded as scripts. Vue-router must be disabled.
```html
Vuesence Book demo
new Vue({ el: '#app' })
```
# Features
- Simple, responsive, lightweight, fast
- Easily and fully customizable with CSS
- Very suitable for embedding help/documentation content into the website
- Easy to use content management
- Focus on performance - articles can be preloaded
- Unlimited nesting levels for TOC tree menu
- In general no dependencies (optional `marked` or other MD library for markdown support and `vue-router` for routing)
# Documentation
Detailed documentation can be found here - https://vuesence.github.io/vuesence-book/
## Content management
Unlike many other documentation systems **Vuesence Book** is not a *static site generator*. You can change the content without rebuilding the entire website.
`vbcfg.json` configuration file defines the content tree (TOC in the left column). It also contains links to articles in HTML or Markdown formats or the content of the article itself in an HTML format
```
└── vb
├── pages
│ ├── intro.md
│ ├── desc.md
│ └── rich-content.html
├── vbcfg.json
└── index.html
```
Self-explaining example of the `vbcfg.json` and articles of the documentation can be found here -
https://github.com/vuesence/vuesence-book/tree/master/docs
## Playground
Try it on codesandbox.io (Node.js version)
> ! The version on `codesandbox.io` might be slightly out of date
## Check out my other Vue.js components
- Sliding header - Vue.js component representing sliding header (or two different headers)
- Cloud Sync Button - a button with cloud synchronization animation
- Modal Window - simple lightweight Modal Window Vue.js component
You like Vuesence Book? Star it and retweet it!
-------
## Troubleshooting
Any bugs, issues, feature and pull requests are welcome
Please use GitHub's issue reporter or send me an email
## Contribution
Contribution is always welcome and recommended. Here is how:
- Fork the repository
- Clone to your machine
- Make your changes
- Create a pull request
## Areas for improvements / involvement
- More convenient fenced code block highlighting
- Full-text search
- CSS layout improvement (responsiveness)
- Themes
- Top nav bar
- Footer for stand-alone version
- CEO issue
## Change Log
- 0.4.2 small fixes on menu
- 0.4.50 release
## License
**@vuesence/book** package is freely distributable under the terms of the [MIT license](LICENSE).