Skip to content

nxc: a PyPI package to build websites from collections of Markdown files

Notifications You must be signed in to change notification settings

Massive-Wiki/nxc

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

nxc PyPI package

Overview

The nxc PyPI package proveds a command-line utility that:

  1. initializes an nxc project directory with required configuration and web template files to support web publishing. This utility copies a predefined set of templates into a specified directory.
  2. builds a static website from Markdown files in an initialized directory.

Features

  • Directory Initialization: Creates a new directory or utilizes an existing one (if empty, or if not yet initialized) to set up the starter files.
  • Website Building: Constructs a static website from a collection of Markdown files.
  • Error Handling: Provides logging and error handling to manage issues like non-empty directories or permission errors.
  • Template Copying: Copies specific template files and directories from a templates adjacent to the script.

Requirements

  • Python 3.8
  • Access to file system operations that might need administrative, or appropriate user, permissions depending on the setup.

Usage

  • To be documented once the PyPI package testing is completed.

About

nxc: a PyPI package to build websites from collections of Markdown files

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published