trangntt-016/static-site-generator

Hi there, I'm Trang Nguyen (Tracy)

I'm a Computer Programming Student!

Connect with me:

WhatsApp Telegram

Don't hesitate to get in touch!

---

🥅 Achievement

President’s Honour List – Fall 2020

---

🛠️ Skills

Languages

Back-End Development

Front-End Development

Database

Version Control

Deployed on

Testing

Platform

---

---

📝 Blogs

Geek Culture

Chatrooms with history conversations, user’s online status, notification of unread messages using Spring Boot, Angular, MySQL

Optimization... optimization everywhere

Push Notification for Order Placed Using Observable Design Pattern with Spring Boot, WebSocket, Angular

---

static-site-generator's Issues

Add support for config.json

Describe the feature

Hi @trangntt-016, I want to add support for reading in a config.json as an alternative to CLI arguments (e.g. --input, --lang,...).

ssg --config ./ssg-config.json

{
  "input": "./docs",
  "output": "./web",
  "future-feature": "should be ignored for now"
}

Describe the solution

For supporting --config, I'll add another @CommandLine.Option. If the --config flag is used, ignore other flags.

I'm going to init the value of JssgApplication with pairs from the JSON file. That way, all the logic for parsing the file can be the same. To parse the JSON config, I'll have to add org.json or GSON as a dependency.

Create a page for docs (md files)

This feature displays a list of documentation for .md files

• Any -i for .md will be placed in ./docs 
• index.html will render a new link Pages (which includes the generated stories from text files and Docs (which includes the generated documents from .md files)

Approach:

• Modify the current index.html to have another link to the docs
• Create a new path ./docs to store .md files

Text processing

The file is reading line by line and then transfer to the paragraphs by parsing it into StringBuilder first. Suggestion: for the later development, could it be more precise?

Add an optional -l, --lang, and/or \l flag, which indicates the language to use

Add an optional -l, --lang, and/or \l flag, which indicates the language to use when generating the lang attribute on the root element. For example, --lang fr would mean that the HTML documents are in French, and would include , while -l pt-BR would mean the text is using Brazilian Portuguese: . By default, use en-CA for Canadian English.

index.html is not created with jssg -i folder

Hi, when running jssg -i , index.html is not created with the links with processed HTML files. Suggestion for later on development!

Remove code duplication

https://github.com/trangntt-016/static-site-generator/blob/main/src/main/java/com/os/jssg/utils/HTMLUtils.java#L24-L34 and https://github.com/trangntt-016/static-site-generator/blob/main/src/main/java/com/os/jssg/utils/FileUtils.java#L62-L93 are very similar, and one of these should be removed. I'd suggest leaving all HTML logic in the HTMLUtils.

Full markdown support

This feature helps to compose the interactive documentations with ease

• .md will be converted to .html with full features (< h1 >, < ul > , < li >,< strong >, < em > , etc.)
• Syntax Highlighting for code blocks

Approaches:

• Install Java library (txtMakr) to convert .md to .html
• Write function to read the code block (some codes) and convert them to some codes
• Refactor current codes

Problem with jssg configuration

Hi, could you please add more detailed direction on the read me for jssg configuration?

Add support for inline <code> blocks

Add support for inline blocks. In Markdown, enclosing text in a single backtick causes the text to HTML to get rendered as ...text....