Giter Club home page Giter Club logo

csx-ssg's Introduction

๐Ÿค– csx-ssg - a static site generator

๐Ÿ“„ Summary

This static site generator turns markdown files into fully-fledged static pages.

It is one of the guided project assignments from the boot.dev backend course.

It supports the standard markdown syntax, such as:

  • Headers,
  • Links,
  • Images,
  • Lists,
  • Quotes,
  • Codeblocks,
  • Text formatting,
  • ... and anything else you'd expect from markdown.

๐Ÿ›  Requirements

  • Python 3.9+
  • A web browser

๐Ÿš€ Usage

  • Download the source code
  • Add markdown files to the /content directory. Feel free to use folders for nesting.
  • Add any static content such as stylesheets, images or videos to the /static folder. You may reference these in your markdown files.
  • Once you're done, run the main.sh script.
  • All done! Your generated site should be in the /public directory.

โš  Warning

This software was written and tested on Linux. If you are a Windows user and run into problems, feel free to open an issue or modify the source code yourself. Pull requests are welcome.

csx-ssg's People

Contributors

myshkovsky avatar

Watchers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.