1.1.0 • Published 9 months ago
mywiki v1.1.0
MyWiki
Install
npm install -g mywikiMyWiki is a minimalist wiki builder based on markdown. Here's how it works:
- Create markdown files
- All files must be in the exact same directory, no nesting
- The first line will be treated as headline, use the
===headline instead of#
- Create other files (optional)
wiki-header.htmlwill be inserted into the otherwise empty<header />tagwiki-styles.csswill be used instead of the default theme if the file exists
- Build
- Run the
mywikicommand in the directory of the files
- Run the
Done
- The generated HTML will be in the
./distdirectory
- The generated HTML will be in the
Theming
MyWiki ships with a default theme. If you want to build your own theme, use this HTML structure as a reference:
<!DOCTYPE html>
<html>
<head>
<title>${navData.title}</title>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width,initial-scale=1">
<style>
/* YOUR STYLES WILL BE INSERTED HERE */
</style>
</head>
<body>
<header>
<!--YOUR HEADER WILL BE INSERTED HERE-->
</header>
<nav>
<li><a href="path/to/file.html" class="active">File 1</a></li>
<li><a href="path/to/file.html" class="">File 2</a></li>
</nav>
<main>
<!--CONTENT WILL BE INSERTED HERE-->
</main>
</body>
</html>