Skip to content
/ sych Public

create extensible technical documentation from markdown files

Notifications You must be signed in to change notification settings

sychdoc/sych

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

30 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

sych

Introduction

Sych short for psych is to understand the psyche of the developers who has worked on a specific part of the code. They can do a memory dump of feature they are developing by creating a markdown file anywhere inside the project. It just looks for all markdown files inside your project folder and creates a very nice docs. It creates a single static .html which can be shared or looked at by other people.

Running sych is quite simple, you just put the sych binary from release to your PATH and run

sych

Goal

The goal of sych is to save developer's time by keeping the documentation inside the project itself and to provide a **[powerful and extensible]** document generation engine.

Upcoming Features

  • Extensions
  • Themes
  • Search

About

create extensible technical documentation from markdown files

Topics

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published