Skip to content

alexb7711/pymind

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

MIT Liscense Test runs Coverage Status CodeQL

PyMind

This project is another static website generator with the primary goal of being very simple, yet extremely extensible. Pymind uses Python Markdown, so you can use its features seamlessly (see configuring Pymind). To see what PyMind offers, see the Features page.

Quick Start

PyMind can be executed as a command line application, or be used as a Python module. But first you need to install it. After cloning the repository, run make install in the PyMind directory.

Note: The makefile is a bit rough, if you are getting an error try opening the makefile changing the pipx commands to pip.

Example of PyMind being used as an application

pymind -i [DIRECTORY TO SEARCH] -o [DIRECTORY TO OUTPUT HTML]

Example of PyMind being used as a module:

import pymind

args = {"config": Path("path/to/pymind.toml")}

pymind.pymind(**args)

TODOs

  • Add support for external plugins
  • Create a built-in plugin to generate a page outlining the project structure (based on input directory)
  • Enable/disable individual/all built-in/external plugins
  • Scheduled auto update git repository and publication

Support

You may report bugs, ask for help, and discuss various other issues on the bug tracker.

About

Simple and easy note linking and website generation

Resources

License

Stars

Watchers

Forks

Releases

No releases published