DEV Community πŸ‘©β€πŸ’»πŸ‘¨β€πŸ’»

Cover image for OSD600 - Enhancing Siteit’s markdown features
TD
TD

Posted on • Updated on

OSD600 - Enhancing Siteit’s markdown features

About Siteit

Siteit is a CLI tool that can .txt and .md files into HTML. Read more about Siteit here or check out the GitHub repo.

New Features

Over a week ago, my peer implemented initial markdown support to bolster Siteit’s existing SSG capabilities. This week, I am to add new markdown features to the repo.

Feature #1

I started by filing an issue regarding Siteit’s lack of ability to process code blocks. Then I began by implementing its source code and frequently committing it to a new git branch. After thoroughly testing my work, I pushed the changes to GitHub.

Feature #2

I filed another issue regarding Siteit’s lack of ability to add Horizontal Rule in rendered HTML. Then I implemented the code, tested it, and pushed the changes to GitHub.

Outcome

Users can now supply a markdown file containing lines of source code enclosed within a pair of backticks.
When Siteit is processing markdown files and encounters lines containing an instance of a backtick, followed by some text and one or more backticks, it will accurately render the text within a pair of <code>…</code> blocks. Furthermore, instances of --- in markdown files are rendered as <hr> in generated HTML.

Overall it was fun to practice several features of Git while adding new features to Siteit.

Latest comments (0)

We are hiring! Do you want to be our Senior Platform Engineer? Are you capable of chipping in across sysadmin, ops, and site reliability work, while supporting the open source stack that runs DEV and other communities?

This role might just be for you!

Apply now