DEV Community

Minsu Kim
Minsu Kim

Posted on

Kimchi-SSG Release 0.01

Built with

Author

Minsu Kim

License

MIT

Repository

https://github.com/mkim219/kimchi-ssg

Feature

  • Parse the title from the input file
  • Improve look and feel of generated HTML

Installation

There are two methods you can use Kimchi-ssg

  • Installation
  • Without Installation

Installation

  1. Clone repository
  2. Open command prompt and change directory where you clone the repository
  3. Change directory into ./kimchi-ssg/bin/release where you can find kimchi-ssg.1.0.0.nupkg Nuget package for installation
  4. On the command prompt, type dotnet tool install --global --add-source {your project directory including kimchi-ssg.1.0.0.nupkg} kimchi-ssg
  5. Check installation dotnet tool list --global

Without Installation

  1. Clone repository
  2. Open "kimchi-ssg.csproj" C# project file
  3. Build the project with ctrl+shift+B (if you Windows user)
  4. Go to directory "\bin\Release\net5.0", you can find kimchi-ssg.exe
  5. Run command prompt and change directory where kimchi-ssg.exe locates at

Option

  • --i --input <arguments> Input your text file to convert html
  • --version Show version information
  • -?, -h, --help Show help and usage information

Usage

Installation

  1. Go directory where your text file to be converted into HTML file
  2. Run kimchi-ssg --input ./{current directory} command if you want to convert multiple text file into HTML files
  3. Run kimchi-ssg --input {filename.txt} command if you want to convert single text file into HTML file
  4. Your file generate dist folder in your current directory

Without installation

  1. Make sure your text files in folder where kimchi-ssg.exe exists
  2. Run the same code on instruction at Installation above (step 3 and 4)

Discussion (1)

Collapse
juuuuuuun profile image
jsong89

Nice ssd :)