The 0doc from josephernest

Add feature to include external .md files directly on the fly

These topics http://stackoverflow.com/a/21096828/1422096, https://github.com/LexmarkWeb/csi.js/blob/master/src/csi.js, http://stackoverflow.com/a/40957869/1422096 give an interesting idea:

Having

<div id="content">
    <file src="introduction.md"></file>
    <file src="chap1.md"></file>
    <file src="chap2.md"></file>
</div>

would automatically include the relevant files and replace the tag by the file content.

Note: this would only work with a server. Accessing to the site with file://... would generate a Cross Origin issue, at least on Chrome.

Error when formatting index.html

Format the index.html e.g. with Atom beautify:

<!--
# 0Doc is a documentation writing tool. Just write your doc with Markdown syntax in the #content <div>.
# author:  Joseph Ernest (twitter: @JosephErnest)
# url:     https://github.com/josephernest/0Doc/
# license: MIT license
 -->

<!DOCTYPE html>
<html>

<head>
    <title>0Doc</title>
    <meta http-equiv="content-type" content="text/html; charset=utf-8" />
    <meta name="viewport" content="width=device-width, initial-scale=1.0">
    <link rel="icon" href="favicon.ico" />
    <script src="https://cdnjs.cloudflare.com/ajax/libs/jquery/1.12.4/jquery.min.js"></script>
    <script src="https://cdnjs.cloudflare.com/ajax/libs/marked/0.3.6/marked.min.js"></script>
    <script src="https://cdnjs.cloudflare.com/ajax/libs/mark.js/8.4.2/jquery.mark.min.js"></script>
    <link rel="stylesheet" href="style.css" />
    <noscript>This page requires JavaScript.</noscript>
</head>

<body>
    <div id="content">

        <!-- Begin writing your doc here -->

        # Introduction

        ## Subtitle A

        ![](https://i.imgur.com/Kyhqkt3.jpg)

        Lorem ipsum dolor sit amet, consectetur adipisicing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum.

        Lorem ipsum dolor sit amet, consectetur adipisicing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum.

        ## Subtitle B

        Lorem ipsum dolor sit amet, consectetur adipisicing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum.


        # Installation

        As stated by @UserA on http://www.example.com:

        > Lorem ipsum dolor sit amet, consectetur adipisicing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum.

        You need to use this code:

            ls -la
            mkdir test
            cd test

        Lorem ipsum dolor sit amet, consectetur adipisicing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum.

        Lorem ipsum dolor sit amet, consectetur adipisicing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum.

        Lorem ipsum dolor sit amet, consectetur adipisicing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum.


        # About

        ## Subtitle C

        Lorem ipsum dolor sit amet, consectetur adipisicing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum.

        ## Subtitle D

        Lorem ipsum dolor sit amet, consectetur adipisicing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum.



        <!-- Doc finished here. -->

    </div>

    <div id="nav">NAV</div>
    <div id="left" class="collapsed">
        <div id="logo">
            <a href="index.html"><img src="logo.png" /></a>
        </div>
        <div id="search">&#128269;<input id="inputsearch" placeholder="Search" type="text"></div>
        <div id="toc">
            <ul id="toc_ul"></ul>
        </div>
        <div id="footer">Documentation powered by <a href="https://github.com/josephernest/0Doc/">0Doc</a>.</div>
    </div>

    <script src="0doc.js"></script>
</body>

</html>

An error TypeError: selectednavitem.position(...) is undefined will be thrown.

josephernest / 0doc Goto Github PK

0doc's People

Contributors

Stargazers

Watchers

Forkers

0doc's Issues

Improve design for top left small navigation button (for phone with browser width < 600 px)

Add feature to include external .md files directly on the fly

Error when formatting index.html

h1, h2 with duplicate text

Page scrolling should update Table of contents selected item, and index.html#id in URL bar

Search feature

Recommend Projects

React

Vue.js

Typescript

TensorFlow

Django

Laravel

D3

Recommend Topics

javascript

web

server

Machine learning

Visualization

Game

Recommend Org

Facebook

Microsoft

Google

Alibaba

D3

Tencent