souvikns / diplodoc

A static site generator

Hi there 🙋‍♂️

This is Souvik, self taught software developer, currently working fulltime on @asyncapi.

• 💼 Maintainer @asyncapi.
• 🔭 I'm currently working on asyncapi/cli.
• 🎓 Bachelor of Engineering in Computer Science.
• 🌱 I'm currently learning TypeScript and dependecy injection.
• 💬 Ask me about anything here
• ✍🏻 Writting blogs on hashnode.
• ⚡ Fun-Fact: I love anime.

Languages and Tools:

📃 Blogs

• How to generate and serve images.
• What is TDD and why should you care?
• What React in Terminal?🤨

🏅 Stats

My Streak Stat

GitHub Stat

---

diplodoc's Issues

[Feature]Theme support

[Feature]Create Command

Introduction

This command will bootstrap diplodoc app. For now, all it will do is spit out some directories and files.

File structure

- pages 
- components
- diplodoc.config.js 
- package.json 
- static 
    - images 

Setup jest for testing

reader support for static files

Static files

• png
• jpg
• svg

[FEATURE]build command

For now, we will just be converting the .md files into html files and bundle all styles and static files.

[Feature]CLI specification

As for now, the functionalities are

• build
• create
• dev

build command

diplodoc will be converting .md files to .html also adding styles and static content and spit all these files into a build folder

create command

This command will generate a diplodoc project structure template.
basic template

- pages
    - index.md
- static
    - images
        - logo.png
- diplodoc.config.js

dev command

This command will just create a dev server and run on port localhost:3000 for development purpose.

[Feature]config.yml file support

(JS-D009) Prefer ternary operator

Description

Using an if-else statement typically results in more lines of code than a single-line ternary expression, which leads to an unnecessarily larger codebase that is more difficult to maintain. Additionally, using an if-else statement can result in defining variables using let or var solely to be reassigned within the blocks. …

Occurrences

There is 1 occurrence of this issue in the repository.

See all occurrences on DeepSource → deepsource.io/gh/Souvikns/diplodoc/issue/JS-D009/occurrences/

[Feature]Template support

setup nodejs workflow and code coverage

read all md files from pages folder

(JS-0112) Unnecessary `catch` clauses found

Description

A catch clause that only rethrows the original error is redundant, and has no effect on the runtime behavior of the program. These redundant clauses can be a source of confusion and code bloat, so it's better to disallow these unnecessary catch clauses. Example - The not-preferred way : ```js …

Occurrences

There is 1 occurrence of this issue in the repository.

See all occurrences on DeepSource → deepsource.io/gh/Souvikns/diplodoc/issue/JS-0112/occurrences/

[Feature]File reader and watcher support

Both the build command and dev command will access files thus it makes sense to have a separate class for these functionalities

Build

The build command will just read all the files and folders once

dev

The dev command will keep on updating the files when there will be any changes.