This is a new feature in (beta version), you can get it by: docute@2.11 <script src="https://unpkg.com/docute@next"></script> A short introduction to Docute: It’s a JavaScript file that turns your markdown files into a docs website on the fly, built with Vue.js and marked If you know you already know , except that Docute supports multi-pages and has many more features. Flatdoc Docute (BTW, I knew flatdoc from ’s post after I made docute 😜) André Staltz ⬅️ And this is how it looks like. It does not look that special right? The design is clean & Make website without build process might be its core selling points. (It does has a in case you wonder.) plugin system So here I’m going to introduce another feature, : combine the power of Markdown & Vue component example docute app https://gist.github.com/egoist/f4f590a1e9d4a0afc2d62eae6db8789f Basically the option is similar to in many router libraries, it defines how the user enters a page, by default it fetches markdown file matches by the option, for example will fetch for you, but you can also use option to write inline markdown if your website isn’t that large. nav routes path path: '/get-started' get-started.md markdown The fetched content will be parsed by and rendered as simple HTML string. But if you use option which is a simple Vue component object, the parsed HTML string will be used as the component’s value, and we finally render the Vue component as a part of the app. marked component template Wrap It Up Docute is a documentation framework: writing docs without build process (i.e. make website fast!) a powerful plugin system a kind of clean and elegant design writing docs with markdown and Vue component opt-in Related link: Docute’s website: https://docute.js.org Docute’s source code: https://github.com/egoist/docute How to run code blocks in Markdown: https://github.com/egoist/docute-iframe

Fetch

Too Long; Didn't Read

In your car, at home, or at work — Bosch technology shapes many areas of life.

Writing docs using Markdown and/or Vue component without build process

Too Long; Didn't Read

Company Mentioned

EGOIST

About Author

TOPICS

THIS ARTICLE WAS FEATURED IN...

Writing docs using Markdown and/or Vue component without build process

Too Long; Didn't Read

Company Mentioned

EGOIST

About Author

TOPICS

THIS ARTICLE WAS FEATURED IN...

RELATED STORIES