{"id":25150065,"url":"https://github.com/vuesence/vuesence-book","last_synced_at":"2026-04-03T01:01:43.089Z","repository":{"id":44949850,"uuid":"258979793","full_name":"vuesence/vuesence-book","owner":"vuesence","description":"Minimalistic Vue.js based documentation system component","archived":false,"fork":false,"pushed_at":"2023-11-13T03:45:12.000Z","size":3489,"stargazers_count":52,"open_issues_count":0,"forks_count":6,"subscribers_count":4,"default_branch":"master","last_synced_at":"2025-06-18T20:46:06.525Z","etag":null,"topics":["doc","docs","documentation","documentation-tool","markdown","web-components"],"latest_commit_sha":null,"homepage":"","language":"Vue","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/vuesence.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null}},"created_at":"2020-04-26T08:33:50.000Z","updated_at":"2025-01-26T09:31:51.000Z","dependencies_parsed_at":"2024-04-13T03:49:20.196Z","dependency_job_id":null,"html_url":"https://github.com/vuesence/vuesence-book","commit_stats":null,"previous_names":["altrusl/vuesence-book"],"tags_count":1,"template":false,"template_full_name":null,"purl":"pkg:github/vuesence/vuesence-book","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/vuesence%2Fvuesence-book","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/vuesence%2Fvuesence-book/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/vuesence%2Fvuesence-book/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/vuesence%2Fvuesence-book/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/vuesence","download_url":"https://codeload.github.com/vuesence/vuesence-book/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/vuesence%2Fvuesence-book/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":262667247,"owners_count":23345524,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["doc","docs","documentation","documentation-tool","markdown","web-components"],"created_at":"2025-02-08T22:16:32.282Z","updated_at":"2026-04-03T01:01:42.408Z","avatar_url":"https://github.com/vuesence.png","language":"Vue","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Vuesence Book\n\nMinimalistic Vue.js based documentation system component\n\n![Node.js CI](https://github.com/altrusl/vuesence-book/workflows/Node.js%20CI/badge.svg)\n[![Known Vulnerabilities](https://snyk.io/test/github/altrusl/vuesence-book/badge.svg)](https://snyk.io/test/github/altrusl/vuesence-book)\n[![Dependabot Status](https://api.dependabot.com/badges/status?host=github\u0026repo=altrusl/vuesence-book)](https://dependabot.com)\n\u003c!-- [![Dependencies](https://david-dm.org/altrusl/vuesence-book.svg)](https://david-dm.org/altrusl/vuesence-book.svg) --\u003e\n\n![VB-preview](https://vuesence.github.io/vuesence-book/images/vb-preview.gif)\n\n\n# How to use\n\n**Vuesence Book** can be used as a Vue component in a Vue.js project or stand-alone in a browser\n\n## Node.js usage example\n\n```bash\nnpm install @vuesence/book --save\n```\n\n```html\n\u003ctemplate\u003e\n  \u003cdiv id=\"app\" class=\"app\"\u003e\n    \u003cvuesence-book \n      header-title=\"My Book\" \n      :use-router=\"false\"\n    /\u003e\n  \u003c/div\u003e\n\u003c/template\u003e\n\n\u003cscript\u003e\nimport VuesenceBook from \"@vuesence/book\";\n\nexport default {\n  name: \"App\",\n  components: {\n    VuesenceBook\n  }\n};\n\u003c/script\u003e\n\n\u003cstyle\u003e\n    @import './css/default.css';\n    /* @import './css/vuepress-style.css'; */\n    /* @import './css/google-style.css'; */\n\u003c/style\u003e\n```\n## Browser usage example\n\nThe **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.\n\n```html\n\u003c!DOCTYPE html\u003e\n\u003chtml lang=\"en\"\u003e\n\n\t\u003chead\u003e\n\t\t\u003ctitle\u003eVuesence Book demo\u003c/title\u003e\n\n\t\t\u003cscript src=\"https://unpkg.com/vue\"\u003e\u003c/script\u003e\n\t\t\u003cscript src=\"https://unpkg.com/@vuesence/book\"\u003e\u003c/script\u003e\n\n        \u003clink rel=\"stylesheet\" href=\"https://unpkg.com/@vuesence/book/src/css/default.css\"\u003e      \n\t\t\u003c!-- You can plug in any custom CSS here to style the Vuesence Book--\u003e\n\t\t\u003c!-- \u003clink rel=\"stylesheet\" href=\"css/vuepress-style.css\"\u003e --\u003e\n\t\t\u003c!-- \u003clink rel=\"stylesheet\" href=\"css/google-style.css\"\u003e --\u003e\n\t\u003c/head\u003e\n\n\t\u003cbody\u003e\n\t\t\u003cdiv id=\"app\" class=\"app\"\u003e\n\t\t\t\u003cvuesence-book\n\t\t\t\theader-title=\"My Book\"\n\t\t\t\t:use-router=\"false\"\n\t\t\t/\u003e\n\t\t\u003c/div\u003e\n\t\u003c/body\u003e\n\n\t\u003cscript\u003e\n\t\tnew Vue({ el: '#app' })\n\t\u003c/script\u003e\n\n\u003c/html\u003e\n```\n# Features\n\n- Simple, responsive, lightweight, fast\n- Easily and fully customizable with CSS\n- Very suitable for embedding help/documentation content into the website\n- Easy to use content management\n- Focus on performance - articles can be preloaded\n- Unlimited nesting levels for TOC tree menu\n- In general no dependencies (optional `marked` or other MD library for markdown support and `vue-router` for routing)\n\n\n# Documentation\n\nDetailed documentation can be found here - \u003ca href=\"https://vuesence.github.io/vuesence-book/\" target=\"_blank\"\u003ehttps://vuesence.github.io/vuesence-book/\u003c/a\u003e\n\n\n## Content management\n\nUnlike many other documentation systems **Vuesence Book** is not a *static site generator*. You can change the content without rebuilding the entire website.\n\n`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\n\n```\n└── vb\n    ├── pages\n    │   ├── intro.md\n    │   ├── desc.md\n    │   └── rich-content.html\n    ├── vbcfg.json\n    └── index.html\n```\n\nSelf-explaining example of the `vbcfg.json` and articles of the documentation can be found here - \n\u003ca href=\"https://github.com/vuesence/vuesence-book/tree/master/docs\" target=\"_blank\"\u003ehttps://github.com/vuesence/vuesence-book/tree/master/docs\u003c/a\u003e\n\n\n## Playground\n\nTry it on \u003ca href=\"https://codesandbox.io/s/vuesence-book-0rfh5\" target=\"_blank\"\u003ecodesandbox.io\u003c/a\u003e (Node.js version)\n\n\u003e ! The version on `codesandbox.io` might be slightly out of date\n\n![sbio](https://vuesence.github.io/book/images/csbio.jpg)\n\n## Check out my other Vue.js components\n\n\u003c!-- - \u003ca href=\"https://github.com/altrusl/vuesence-book\" target=\"_blank\"\u003eVuesence book\u003c/a\u003e - minimalistic Vue.js based documentation component --\u003e\n- \u003ca href=\"https://github.com/altrusl/vuesence-sliding-header\" target=\"_blank\"\u003eSliding header\u003c/a\u003e - Vue.js component representing sliding header (or two different headers)\n- \u003ca href=\"https://github.com/altrusl/vuesence-cloud-sync-button\" target=\"_blank\"\u003eCloud Sync Button\u003c/a\u003e - a button with cloud synchronization animation\n- \u003ca href=\"https://github.com/altrusl/vuesence-modal-window\" target=\"_blank\"\u003eModal Window\u003c/a\u003e - simple lightweight Modal Window Vue.js component\n\n\n\u003cimg src=\"https://imgur.com/A92i02A.png\" /\u003e\nYou like Vuesence Book? Star it and \u003ca href=\"https://twitter.com/vuesence/status/1280084578288443392?s=20\"\u003eretweet it!\u003c/a\u003e\n\n-------\n\n\n## Troubleshooting\n\nAny bugs, issues, feature and pull requests are welcome\n\nPlease use GitHub's issue reporter or send me an \u003ca href=\"mailto:ruslan.makarov@gmail.com\"\u003eemail\u003c/a\u003e\n\n\n## Contribution\n\nContribution is always welcome and recommended. Here is how:\n\n- Fork the repository\n- Clone to your machine\n- Make your changes\n- Create a pull request\n\n## Areas for improvements / involvement\n- More convenient fenced code block highlighting\n- Full-text search\n- CSS layout improvement (responsiveness)\n- Themes\n- Top nav bar\n- Footer for stand-alone version\n- CEO issue\n\n## Change Log\n\n- 0.4.2 small fixes on menu\n- 0.4.50 release\n\n## License\n\n**@vuesence/book** package is freely distributable under the terms of the [MIT license](LICENSE).\n\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fvuesence%2Fvuesence-book","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fvuesence%2Fvuesence-book","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fvuesence%2Fvuesence-book/lists"}