Git Product home page Git Product logo

ssgulnur's Introduction

SSGulnur

SSGulnur

Overview

SSGulnur is a command-line tool to generate static HTML web pages from a provided file or folder.

Installation

Node is required. Run npm to install globally npm install --global ssgulnur.

Please use bash terminal.

Usage

ssgulnur -v | --version

Displays the tool's name and current version.

ssgulnur -h | --help

Displays a help guide with all instructions.

Help guide
SSGulnur is a command-line tool to generate static HTML web page from a provided file or folder.
Usage:
ssgulnur -v | --version current version
ssgulnur -h | --help help guide
ssgulnur -i | --input <source> specify a file or folder to use
Options for input:
-o | --output <folder> specify an output folder for produced html
By default, the output folder would be ./dist unless specified otherwise
-s | --stylesheet <url> specify a stylesheet url to use
For example, https://cdn.jsdelivr.net/npm/water.css@2/out/water.css
Config:
-c | --config <file> specify a config file to use

ssgulnur -i | --input

  • Supported file types are .txt and .md.
  • Source can be a single file or a folder which can also contain sub-folders with files.
  • For file names with spaces, please use quotation marks. For example: ssgulnur -i "Example file path.txt".
  • For each provided file an html file will be generated. By default, all html files will be placed into the ./dist folder.
  • All titles need to be the first line in the file followed by two blank lines. Otherwise, it will be considered as part of the story.

Options

Option Argument Description
-o | --output <folder> Allows to specify an output folder name. If exists, will be used, if not, gets created.
Cannot be a file. By default, ./dist.
-s | --stylesheet <url> Allows to specify a particular stylesheet to use for html styling.
For example, https://cdn.jsdelivr.net/npm/water.css@2/out/water.css

Examples

  • ssgulnur -i "Example file path.txt"
  • ssgulnur --input exampleFolderPath --output exampleOutputFolderPath
  • ssgulnur -i exampleFolderPath -o exampleOutputFolderPath -s "https://www.exampleCSSurl.com"

ssgulnur -c | --config

  • Allows the user to consolidate the above options inside of a JSON file, instead of using the command line to specify options.
  • For file names with spaces, please use quotation marks. For example: ssgulnur -c "Example file path.json".

Config File Example:

example.json

{
  "input":"./path/to/input/files",
  "output":"./path/to/output/files",
  "stylesheet":"https://cdn.jsdelivr.net/npm/water.css@2/out/water.css"
}

Stories folder is provided as a sample which you can use. It contains five Sherlock Holmes stories by Sir Arthur Conan Doyle and a markdown sample file. Generated static pages for the sample can be seen here: https://ssg-gulnur-sample.vercel.app

Bugs and new features

If you notice a bug or have a suggestion for a new feature, please go to the issues tab of the project and check if similar ideas do not already exist. If there are no duplicates, please create a new issue and document it giving as many details as possible.

Contribution

Contributions are always welcome! Please check the CONTRIBUTING.md file for more details.

ssgulnur's People

Contributors

gulyapulya avatar mnosov622 avatar rokaicker avatar

Watchers

 avatar

ssgulnur's Issues

add markdown bold and link syntax features

The intention is to add proper styling support for bold text and links for markdown files. Bold is placed between double asterisk or underline symbols in markdown and has to be transformed into <b> html element. Link is used as [Link](url) and has to be <a> element with href in html.

The last paragraph is not converted

When the files are being converted into html, the last paragraph somehow never gets transformed. It does not paste it into the resulting html.

Update documentation

Current documentation does not include recent changes such as full markdown support. Please go through the issues and figure out what was already implemented but was not covered in docs.

Full markdown support

Currently, SSGulnur supports only some types of the markdown style elements and it would be better to leverage one of the existing modules to cover all of them.

support for config file

I'll add the ability for this program to parse through config json files as an alternative to using command line options

add markdown support

i'll add markdown support to the project and add the ability to parse italicized markdown text

add markdown heading syntax features

The intention is to add proper styling support for headings 1 and 2 for markdown files. Headings are started with # or ## signs in markdown but have to be <h1> or <h2> in html.

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.