sebastienrousseau / shokunin Goto Github PK

❌Current release v0.0.6 unit test coverage is too low

• Increase unit tests code coverage to minimum threshold of 90%

📚Complete shokunin documentation

• Summary
• Features
• Examples and Usage
• Contributing
• License

❌ Current release v0.0.6 is missing the template directory available when running outside:

ssg --new=my-site --content=content --output=output

Propose resolution

• Add ability to download a template when running the command line. This will allow users to host their own template files and or use community ones
• Add the template as a new argument

ssg --new=my-site --template=template --content=content --output=output

🧪 Enhancing and optimising the template file and logic

• Minimising html template to 5kb
• Add minification
• Add new templates
• Increasing Validations:
  - Validate HTML structure using W3C HTML Validation
  - Validate Link check
  - Validating page titles
  - Validating DOM element exists
  - Validating CSS classes

🧪 Add support for RSS 2.0 template (rss.xml)

• Template name rss.xml
• Template should be rendered for each files (e.g. about.xml, home.xml)
• Template should validate against https://validator.w3.org/feed/docs/rss2.html

❌ Content-Type is missing on the local server for JS

sw.js is not served with the correct Content-Type header. It is missing or has a value other than application/javascript

Hi, just stumbled across this project and found it interesting. I noticed that the links for Bug Report, Feature Request and Contributing Guidelines are broken in the README file.

I could fix that for you if you'd take a PR for that.

BTW: I'd like to contribute more stuff, but I'm not sure what. So if you have stuff open, feel free to create some issues and I would take a look at it

When the user is missing the new argument, the error message is

Error running shokunin (ssg): ❌ Error: Argument "name" is required but missing.

This confused me quite a lot, i think we should always use the argument's exact name.

I'm going to provide a PR for this.

❌ msapplication-TileImage not declared correctly

I was wondering if there was any documentation on how to actually use this outside of the code itself and the templates. I thought I'd try to take a look at making a blog out of this, but I haven't found any documents as to how to actually use this.

I can probably piece it together if there is no documentation already or documentation planned in the short term, but if there was I'd figure I'd would wait for it.

🧪 Increasing front matter values support

• Adding more front matter values to be supported such as author, categories, featured_image, published etc.
• Please refer to https://frontmatter.codes/docs/content-creation/fields
• Ensuring unit tests, examples and benchmarks are updated accordingly

🧪 Adding other types of content formats to generate from (CSV, YAML, TOML, TXT etc)

• Ability to generate the site from multiple sources

❌ Missing examples both in the documentation and code base

• Adding meaningful examples in code base
• Adding meaningful examples in documentation
• Documenting both on the README and code the examples

🧪 Create the website for shokunin

• Ideally using shokunin to generate it 😄
• The website should be committed to a gh-pages branch
• Key requirements semantic HTML, Scalable Text, under 6kb, Minimal Animations and Visual Effects, W3C and WCAG 2.1
• Ready for localization
• Etc.

Open for ideas!

❌ Bad value navigation for attribute role on element ul.

Error: Bad value navigation for attribute role on element ul.

From line 128, column 21; to line 128, column 80

The error message is indicating that the value "navigation" used for the role attribute on the ul element is invalid.

To resolve the error, you can update the role attribute to a valid value based on the intended purpose of the ul element. For example:

<ul class="navbar-nav ms-auto mb-2 mb-lg-0" role="list">

🧪 Enhancing the CLI for better usability

• If running ssg alone, the appplication should default to the --help menu
• Extend CLI arguments
• Increase usability

🧪 Optimise the Service Worker code so it more robust and following best practices

🧪 Adding Built-in development server

• Native rust server module
• Serves the public local directory

Currently, the application name (provided by the cli's new flag) is not passed to the compile function. Instead, the site name is read with let mut site_name = match env::args().nth(1). This leads to some awkward string manipulations to get the site's name:

I think passing the site's name directly from the clap matches would be better. This also makes sure, that the user can use the cli without using =.

For example:
cargo run -- --new MY_SITE -c content/ -o dist

It seems the code blocks are not supported in md files.
Is it possible to add this feature?

Such as

```ruby
require 'redcarpet'
markdown = Redcarpet.new("Hello World!")
puts markdown.to_html

Hello,
Could you give us a pre-defined or compatible templates list?

🧪 Refactoring lib.rs

• Decoupling into functions and files
• Enhancing readability
• Organising file in a logical and simpler structure
• Increasing unit tests and code coverage

❌ Fix CI GitHub Workflow

• Ensure workflow is fixed, readable
• Automate the creation of a release note

🧪Creating Criterion.rs tests to assess and enhance performance

• Add missing Criterion.rs code and ensure full testing coverage
• Analyse code and see how to fix any bottleneck issues

Hello @sebastienrousseau,

I was looking an SSG for a new project, and just stepped onto you project, and wonder how your lib compete with zola for example ?

Why did you start it in the first place ? What was your complain about the existing tools and thus what do you expect to do fundamentally better/easier/different ?