Skip to content

iam-Akshat/by-example-generator

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

8 Commits
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

By Example Generator

Inspired by Go By Example, this is a generator for creating a website with examples of code in a programming language.

Roadmap

  • Create a basic generator
  • Add support for Markdown
  • [] Add support for custom HTML, CSS, and JS

Usage (not stable)

  1. Clone the repository
  2. Create a folder named content in the root directory
  3. Create a file named index.md in the content folder
  4. Add the following content to the index.md file:
# Title of the website
  1. Create a file named footer.md in the content folder
  2. Add the following content to the footer.md file:
# Created by [Your Name](Your Website) | [Source Code](Your GitHub Repository)
  1. Create a folder for each example in the content folder
  2. TODO...

About

A static site generator to display annotated code

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published