📚 Effortless documentation, done right.

Overview

ATTENTION: this project is no longer actively maintained (I still push some code once in a while), if you want to see improvements on this project, please consider sponsoring me.

Docute

npm version jsdelivr downloads circleci donate

Effortless documentation, done right.

Features

  • No build process, website is generated on the fly.
  • A simple yet elegant UI that is dedicated to documentation.
  • Leveraging the power of Markdown and Vue.
  • Extensible plugin system, plenty of official and community plugins.

Documentation

Resources

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

Docute © EGOIST, Released under the MIT License.
Authored and maintained by EGOIST with help from contributors (list).

Website · GitHub @EGOIST · Twitter @_egoistlily

Issues
  • Docute 4.0 design

    Docute 4.0 design

    • links in sidebar menu will be linked to individual docs page, the links are configurable.
    contribution welcome wip 
    opened by egoist 20
  • fix: tweak header and pager in print view

    fix: tweak header and pager in print view

    Fixes #227

    released 
    opened by chanjsq 15
  • README.md not being applied and Title has the word undefined

    README.md not being applied and Title has the word undefined

    Issuehunt badges

    1. Why I can't see the content of README.md?
    2. Why is the title on the browser's tab say 'Undefined - Oren's Website'

    URL: https://oren.github.io/new/ code: https://github.com/oren/oren.github.io/blob/master/new/README.md

    Thanks!


    IssueHunt Summary

    Sponsors (Total: $40.00)

    Become a sponsor now!

    Or submit a pull request to get the deposits!

    Tips

    :dollar: Funded on Issuehunt bug contribution welcome 
    opened by oren 13
  • [feature request]cover/landing page support

    [feature request]cover/landing page support

    Noticed that cover pages have been supported by docsify since a recent update (well, I don't know the exact version...). As most open source projects are serving an appealing landing page, I think it would be great if we could also create a cover or landing page for docute :)

    feature request 
    opened by idiotWu 11
  • feat: improve css in print view

    feat: improve css in print view

    Fixes #215

    Print view after applying changes in this PR: image

    released 
    opened by kevgathuku 9
  • Server-side rendering

    Server-side rendering

    docute can be used alone as single page app but what if it supports SSR? If you care about SEO then SSR is a big win!

    The further plan is to support generating static html files at some point.

    Maybe it will be the first docs generator that supports:

    • single page app, build docs on the fly
    • server-side rendering, you don't need to build the docs but also have it seo-friendly
    • build to static files, just like traditional static website generator
    feature request 
    opened by egoist 9
  • feat: toggle sidebar children

    feat: toggle sidebar children

    Implement https://github.com/egoist/docute/issues/216

    sidebar

    @egoist Please help to review when you have time 🙇

    released 
    opened by ittus 8
  • [feature request] execute script tag inside markdown

    [feature request] execute script tag inside markdown

    因为一些原因需要在markdown里写一些js但是无法执行,这有什么办法解决么?(index.html里写没问题,但是需要在markdown里写。。)

    enhancement help wanted low priority 
    opened by Molunerfinn 8
  • Use with mermaid.js

    Use with mermaid.js

    Is there a way to use Docute with Mermaid (UML diagrams)?

    difficulty: easy markdown 
    opened by iamjenmackle 8
  • Search in docs

    Search in docs

    Currently there's no universal way to search a keyword in markdown files, the last option I can think of is to generate a json file for these files for searching 🤔 but um.. you need to generate each time after you updated the docs ...

    enhancement help wanted 
    opened by egoist 8
  • use with `router-link`

    use with `router-link`

    use <router-link> in md <router-link to="/test/index">jump</router-link> docute.js:formatted:768 TypeError: Cannot read property '_normalized' of undefined at De (docute.js:formatted:9334)

    opened by ritilyn1991 0
  • chore(deps-dev): bump semantic-release from 15.13.24 to 17.2.3

    chore(deps-dev): bump semantic-release from 15.13.24 to 17.2.3

    Bumps semantic-release from 15.13.24 to 17.2.3.

    Release notes

    Sourced from semantic-release's releases.

    v17.2.3

    17.2.3 (2020-11-16)

    Bug Fixes

    • mask secrets when characters get uri encoded (ca90b34)

    v17.2.2

    17.2.2 (2020-10-29)

    Bug Fixes

    • don't parse port as part of the path in repository URLs (#1671) (77a75f0)
    • use valid git credentials when multiple are provided (#1669) (2bf3771)

    v17.2.1

    17.2.1 (2020-10-12)

    Reverts

    • Revert "feat: throw an Error if package.json has duplicate "repository" key (#1656)" (3abcbaf), closes #1656 #1657

    v17.2.0

    17.2.0 (2020-10-11)

    Features

    • throw an Error if package.json has duplicate "repository" key (#1656) (b8fb35c)

    v17.1.2

    17.1.2 (2020-09-17)

    Bug Fixes

    • add logging for when ssh falls back to http (#1639) (b4c5d0a)

    v17.1.1

    17.1.1 (2020-06-25)

    Bug Fixes

    v17.1.0

    ... (truncated)

    Commits
    • c8d38b6 style: removed line breaks to align with xo rule (#1689)
    • ca90b34 fix: mask secrets when characters get uri encoded
    • 63fa143 docs(plugins): add listing for new plugin (#1686)
    • 2bf3771 fix: use valid git credentials when multiple are provided (#1669)
    • 77a75f0 fix: don't parse port as part of the path in repository URLs (#1671)
    • d74ffef docs: add npm-deprecate-old-versions in plugins list (#1667)
    • 3abcbaf Revert "feat: throw an Error if package.json has duplicate "repository" key (...
    • b8fb35c feat: throw an Error if package.json has duplicate "repository" key (#1656)
    • 18e35b2 docs: reorder default plugins list (#1650)
    • e35e5bb docs(contributing): fix commit message examples (#1648)
    • Additional commits viewable in compare view

    Dependabot compatibility score

    Dependabot will resolve any conflicts with this PR as long as you don't alter it yourself. You can also trigger a rebase manually by commenting @dependabot rebase.


    Dependabot commands and options

    You can trigger Dependabot actions by commenting on this PR:

    • @dependabot rebase will rebase this PR
    • @dependabot recreate will recreate this PR, overwriting any edits that have been made to it
    • @dependabot merge will merge this PR after your CI passes on it
    • @dependabot squash and merge will squash and merge this PR after your CI passes on it
    • @dependabot cancel merge will cancel a previously requested merge and block automerging
    • @dependabot reopen will reopen this PR if it is closed
    • @dependabot close will close this PR and stop Dependabot recreating it. You can achieve the same result by closing it manually
    • @dependabot ignore this major version will close this PR and stop Dependabot creating any more for this major version (unless you reopen the PR or upgrade to it yourself)
    • @dependabot ignore this minor version will close this PR and stop Dependabot creating any more for this minor version (unless you reopen the PR or upgrade to it yourself)
    • @dependabot ignore this dependency will close this PR and stop Dependabot creating any more for this dependency (unless you reopen the PR or upgrade to it yourself)
    • @dependabot use these labels will set the current labels as the default for future PRs for this repo and language
    • @dependabot use these reviewers will set the current reviewers as the default for future PRs for this repo and language
    • @dependabot use these assignees will set the current assignees as the default for future PRs for this repo and language
    • @dependabot use this milestone will set the current milestone as the default for future PRs for this repo and language

    You can disable automated security fix PRs for this repo from the Security Alerts page.

    dependencies 
    opened by dependabot[bot] 0
  • Fix : Content css

    Fix : Content css

    Fix bug double scroll bar showing in code snippet

    opened by hilolo 1
  • Fix typo

    Fix typo

    opened by Shonetow 0
  • api.onUpdate causes rendering to fail

    api.onUpdate causes rendering to fail

    desc

    When you click the title, the document will refresh, but the api.oncontentupdated(fn) will not be called back, which will cause the mermaid rendering to fail

    example

    GIF

    opened by Drincann 0
  • Theme search function

    Theme search function

    Hello, I want to use your theme for blog development.But now there is a lack of a search function.Then I hope the upper right corner can be controlled by js.Could you add a friend to find out?

    opened by ghost 0
  • Select has inverted colors in dark theme

    Select has inverted colors in dark theme

    While using <docute-select> component with dark theme, its content has inverted colors as shows on the screenshot below: Screenshot from 2020-05-12 17-30-12

    Browser: Chrome v.81.0.4044.138

    opened by yegorgunko 0
  • Ability for a standalone file:// is broken

    Ability for a standalone file:// is broken

    Hello!

    I have documentation for my project at this repository that I gradually porting from a raw HTML into Docute: https://github.com/WohlSoft/PGE-Editor-Help/tree/docute

    However, since some moment it no more works locally and it showing blank pages... (no idea how it worked before, maybe after Firefox 68 release).

    I did an attempt to disable CORS:

    fetchOptions: {
        mode: 'no-cors',
    },
    

    however, it now showing just blank files. The source path I use just "./". Снимок экрана_2020-05-06_02-35-32

    How I did use this?

    • I had to use the latest master state.
    • I did the npm install, and then npm run-script build at repository root.
    • I copied "dist" and "lib" directories into the separate folder at my documentation root (_lib sub-directory).
    • I did the simple HTML file to carry the documentation:
    <!DOCTYPE html>
    <html>
    <head>
        <meta charset="utf-8">
        <meta name="viewport" content="width=device-width, initial-scale=1, shrink-to-fit=no">
        <title>Moondust Editor - Manual</title>
        <link rel="stylesheet" href="_lib/docute/dist/docute.css">
        <link rel="stylesheet" href="style.css">
    </head>
    <body>
    <div id="docute"></div>
    <script src="_lib/docute/dist/docute.js"></script>
    <script src="index.js"></script>
    </body>
    </html>
    
    • In index.js I had to declare the documentation tree itself:
    let docuteSourceRoot = './';
    
    new Docute({
        target: '#docute',
        title: 'Moondust Editor - Documentation',
        sourcePath: docuteSourceRoot,
        darkThemeToggler: true,
        fetchOptions: {
            mode: 'no-cors',
        },
        detectSystemDarkTheme: true,
        highlight: ['typescript', 'bash'],
        editLinkBase: 'https://github.com/WohlSoft/PGE-Editor-Help/edit/master/',
        editLinkText: 'Edit this page on GitHub',
        sidebar: [
            {
                title: 'Main',
                children: [
                    {
                        title: 'Intro',
                        link: '/'
                    }
                ]
            }
        });
    
    opened by Wohlstand 3
  • Multilanguage with LTR and RTL languges

    Multilanguage with LTR and RTL languges

    As far as I see, docute's layout is basically LTR which is why another project is forked from it to support RTL (only). I see docute supports multi-language but it is for LTR languages. What if one of the languages be RTL like Persian, Arabic, Urdu,...? Does it support? If not, how to do so?

    opened by ahangarha 2
Releases(v4.23.3)
Owner
Kevin Hazy
Ya boi who loves code.
Kevin Hazy
Landscape-Health Score (LHS) is an auxiliary evaluation tool based on Paddlepaddle framework.

Landscape-Health Score (LHS) is an auxiliary evaluation tool based on Paddlepaddle framework. You can simply drag and drop image files to automatically analyze images and generate simple evaluation reports.

null 8 Jul 25, 2021
🚀 A dashboard for your homelab

Dashy Dashy helps you organize your self-hosted services, by making them all accessible from a single place Features ?? Instant search by name, domain

Alicia Sykes 211 Jul 19, 2021
A HashiCorp Vault UI written with VueJS and Vault native Go API

Goldfish Vault UI - Live Demo Share this repo with your colleagues! What is this? Goldfish - A HashiCorp Vault UI and workflow tool. pic.twitter.com/u

Tony Cai 2.2k Jul 21, 2021
webchat via WebSockets/WebRTC that allows messaging/video call/screen sharing

Live demo: pychat.org, video Table of contents About When should I use pychat How to host pychat Run test docker image Run prod docker image Native se

Andrew 172 Jul 23, 2021
Discover dev news with zero effort 👩🏽‍💻

Welcome to the daily.dev repository The latest dev news delivered to your new tab ????‍?? Made with ❤️ by developers for developers ?? daily.dev daily

daily.dev 3.7k Jul 28, 2021
Nuxt Headless CMS is a template for personal websites and blogs. The project was made with Nuxt.js and Contentful as a headless CMS and Vuetify as a UI framework.

Nuxt Headless CMS Nuxt Headless CMS is a template for personal websites and blogs. The project was made with Nuxt.js and Contentful as a headless CMS

Wojciech Sikora 5 Jul 19, 2021
A Free and Opensource Laravel eCommerce framework built for all to build and scale your business.

A Free and Opensource Laravel eCommerce framework built for all to build and scale your business.

Bagisto 3.7k Jul 24, 2021
:sailboat: Vuejs and Firebase based CMS

Tamiat CMS Tamiat headless CMS Made with ❤︎ by Mahmoud Nouman and contributors Support our development with What It Looks Like Getting Started To get

Tamiat CMS 520 Jul 6, 2021
Responsive Bootstrap 3 Admin Template based on AdminLTE with vue.js

CoPilot is a fully responsive admin template that is forked from AdminLTE. The difference here is that this repo is tailored to use with Vue.js. The U

Gil Ferreira 2.6k Jul 25, 2021
BEEP Account Security Scanner - Detect if your credentials have been compromised (Vue + Ionic)

Beep: mobile account vulnerability scanner Every day, over 4 million online data records are stolen or lost. Beep tells you if your online accounts ha

Modus Create 148 Mar 19, 2021
CoreUI Vue is free Vue admin template based on Bootstrap 4

CoreUI Free Vue Bootstrap Admin Template Description Why we decided to create CoreUI? Please read this article: Jack of all trades, master of none. Wh

CoreUI 2.9k Jul 24, 2021
A framework written in Vue.js for creating command-line like interfaces in web browsers.

promptie A framework for creating command-line like interfaces in web browsers Promptie gives you useful and convenient API's to simulate a CLI like i

Ali Bardakci 80 Mar 8, 2021
TarkovTracker - a webapp for tracking and planning your progress in the game Escape From Tarkov.

TarkovTracker TarkovTracker is a progress tracker meant to help players of Escape From Tarkov. The core goal of the project is to provide insights int

TarkovTracker 12 Jul 28, 2021