Skip to content

Rethunk-Tech/wiki2go

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

9 Commits
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Wiki2go

Features

  • Create a self-contained Wiki from Markdown files.

    • Support for metadata from YAML front matter.
    • Support for GitHub-Flavoured-Markdown.
  • Serve the Wiki as a static website.

  • Use as a Github Action.

Quick Start

# Clone the repository
git clone https://github.com/Rethunk-Tech/wiki2go.git
cd wiki2go

# Build the binary locally
go install ./cmd/wiki2go

# Run the binary
wiki2go --help

Usage

# Create a new Wiki-based project.
wiki2go new my-wiki

# Open the Wiki's contents in your default editor.
wiki2go edit

# Serve the Wiki. (Open in your default browser.)
wiki2go serve --open

License

This repository's binaries and source code are provided under the:
GNU Affero General Public License (AGPL)

About

No description, website, or topics provided.

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages