https://github.com/petekeller2/wiki-builder

Build github wikis from markdown files
https://github.com/petekeller2/wiki-builder

github markdown npm wiki

Last synced: about 2 months ago
JSON representation

Build github wikis from markdown files

• Host: GitHub
• URL: https://github.com/petekeller2/wiki-builder
• Owner: petekeller2
• License: mit
• Created: 2017-12-30T23:57:40.000Z (over 8 years ago)
• Default Branch: master
• Last Pushed: 2024-06-16T09:51:06.000Z (about 2 years ago)
• Last Synced: 2025-10-19T01:19:08.728Z (8 months ago)
• Topics: github, markdown, npm, wiki
• Language: JavaScript
• Homepage:
• Size: 771 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • Contributing: CONTRIBUTING.md
  • License: LICENSE

Awesome Lists containing this project

README

          
[![Build Status](https://travis-ci.org/petekeller2/wiki-builder.svg?branch=master)](https://travis-ci.org/petekeller2/wiki-builder) 

[![dependencies Status](https://david-dm.org/petekeller2/wiki-builder/status.svg)](https://david-dm.org/petekeller2/wiki-builder)

[![license](https://img.shields.io/github/license/mashape/apistatus.svg)](https://github.com/petekeller2/wiki-builder/LICENSE)

[![npm version](http://img.shields.io/npm/v/wiki-builder.svg?style=flat)](https://npmjs.org/package/wiki-builder)

Build github wikis from markdown source files.

# Setup

`npm install wiki-builder --save-dev`

Create a file named wikiConfig.json

```

{

  "wikiDirPath": "",

  "projectDirPath": "",

  "ignoreMdFiles": [],

  "ignoreMdTitles": [],

  "ignoreDirs": [],

  "statsEnabled": false,

  "useGitignore": true,

  "plugins": []

}

```

**wikiDirPath:** Path to wiki directory. ./wiki/ by default.

**projectDirPath:** Path to project directory. ./ by default.

**ignoreMdFiles:** List of files to not add to the wiki. 

To ignore specific files, include the path (example: ./readme.md) 

To ignore files by file name, don't include the path (example: readme.md)

**ignoreMdTitles:** Ignore by the first line of markdown files.

**ignoreDirs:** List of directories to ignore. Includes node_modules.

**statsEnabled:** Creates a stats markdown file for the wiki. This file can 

only be created for git repositories with commits. False by default.

**useGitignore:** Ignore directories and markdown files in 

.gitignore. True by default.

**useLogger:** Errors will be logged to wiki-build.log 

in the project's root directory. True by default.

**plugins:** Add plugins here. These plugins should have 

 corresponding local node modules. If the node_modules directory is not 

in the same directory as the project's root, give the module 

(plugin) path instead of its name. Example Usage: ["plugin-one", "plugin-two"]. 

A list of existing plugins and a guide to creating new ones can 

be found in PLUGINS.md.

# Usage

Run `wiki-builder`. 

package.json example:

```

"scripts": {

    "wiki": "wiki-builder"

  }

```

npx example:

```

npx wiki-builder

```

`wiki-builder` puts files into the 'wikiDirPath'. If you do 

not have a github wiki git submodule, [you can make one.](https://brendancleary.com/2013/03/08/including-a-github-wiki-in-a-repository-as-a-submodule/)