Skip to content

A portable HTML file to render the embedded Markdown without any preview applications/plugins

License

Notifications You must be signed in to change notification settings

ryokat3/wikipack

Repository files navigation

WikiPack

A portable HTML file to pack markdown, image, css, and any data files into single HTML file.

Usage

WikiPack has 2 main functions:

  1. A single HTML file containing both wiki/blog viewer and wiki/blog contents

  2. A single HTML file providing wiki/blog pages without wiki/blog server

Local File System

  1. Open the WikiPack HTML file

  2. Drag-and-drop the directory (not a file 1) holding your markdown and image files

  3. Select 'Pack...' from the pull-down menu, then all files under the directory will be packed in a single HTML file.

  4. Open the saved HTML file. You can find that the saved HTML file packs all your markdown and image files. You can transfer it to anyone as a file, as an attachment of mail, via file server, memory device etc.

CSS

CSS files in the same directory and 'css' sub-directory of the markdown file will be loaded and applied.

Default CSS

Extended Markdown Syntax

Keywords Highlight

Any keywords can be highlighed with a special language name like

#<text-color>[word1,word2,word3,...];%<background-color>[word4,word5,...];#.....

```#blue[text-blue,foo];#dc143c[text-#dc143c,bar];%yellow[background-yellow,baz];%7fff00[background-#7fff00]
text-blue
text-#dc143c
background-yellow
background-#7fff00
```

will be rendered as

<pre>
   <code class="language-#blue[text-blue,foo];#dc143c[text-#dc143c,bar];%yellow[background-yellow,baz];%7fff00[background-#7fff00]">
   <pre>
      <code>
         <span style="color:blue">text-blue</span>
         <span style="color:#dc143c">text-#dc143c</span>
         <span style="background-color:yellow">background-yellow</span>
         <span style="background-color:#7fff00">background-#7fff00</span></code></pre>
      </code>
   </pre>
</pre>

Footnotes

  1. No reference image will be displayed if a markdown file (not directory) is drag-and-dropped

About

A portable HTML file to render the embedded Markdown without any preview applications/plugins

Resources

License

Stars

Watchers

Forks

Packages

No packages published