Code Monkey home page Code Monkey logo

siteit's Introduction

About me

Page WIP.

siteit's People

Contributors

myrfion avatar ririio avatar serpentbytes avatar

Stargazers

avatar avatar

Watchers

avatar

Forkers

cychu42 myrfion seneca-cdot ririio

siteit's Issues

README.md instruction is currently missing.

I understand README.md is most likely still a WIP. As of now, it doesn't provide instruction on how to use the tool and what it is. I think you might want to list Node.js and npm package installation as requirements.

The tool inaccurately shows error message about invalid source files.

Operating Environment

Operation System: Windows 10
Node version: v16.13.2

Issue

If the dist output folder doesn’t exist, the tool inaccurately shows error message about invalid source files.
When dist folder doesn’t exist:
image

When dist folder exists:
image

Content of the input folder:
image

Expected Behaviour

The tool doesn't show any message about the source files when they are valid, regardless of whether the output folder is missing.

Remove commented code

In my opinion, it would be better to remove commented code, you could always return to previous comments and check what was there. Files, where I found commented code, are: utility.js and htmlGenerator.js

Improve CI

Description

There's room for Improvement in the current CI setup in terms of performance. We could also automate release and play with danger-js

Resource:
https://danger.systems/js/

Add the simple markdow support

Feature request

I want to make your tool siteit support conversion of .txt to not only HTML, but also markdown files to HTML.

Features to implement

I want to implement the following markdown feature:

  • Bold text
  • Italic text

Add Support for Config

Having to write a long command line is always a problem in terms of spelling errors.
That's why I believed that adding a "config" flag would help in terms of making it easier for the user to create a long command line
in a much simpler and elegant way by using JSON

Make revisions based on feeback on 0.1

Issue

Some enhancements to the source code are needed.

Details

  • Use all lower case names for files since not all filesystems are case sensitive.
  • Simplify programmatically displaying information from the package.json file by importing it in the following manner:

const { name, version } = require(‘../package.json’)

Add support for inline `<code>` blocks

Feature Request

Add support for inline <code> blocks

Details

In Markdown file , when text is enclosed within a single backtick will cause the HTML to get rendered as <code>... some text...</code>.

Output folder is always immediately deleted.

Operating Environment

Operation System: Windows 10
Node version: v16.13.2

Issue

The tool always deletes the output folder right after successfully running it without error message. The user can’t access the output files.

Expected Behaviour

The output folder isn't deleted and can be accedes by the user to view the result.

Add markdown support for `<hr>`

Feature Request

Add support for the inline horizontal rule.

Details

In the Markdown file, when a single line only contains --- will cause the HTML to render <hr> in its place.

"siteit -i ./source_directory" command generates an error.

Operating Environment

Operation System: Windows 10
Node version: v16.13.2
Command-line shell: PowerShell v5.1.19041.1682

Issue

On my machine, the tool doesn’t run when entering command "siteit -i ./source_directory" as instructed in help guide.
Enter command and output:
image

It does run when running index.js directly:
image

I'm unfortunately not sure whether it's related to my setup or this is a general issue that also occurs for you.

Expected Behaviour

The tool runs like running index.js directly.

Tool doesn't work with filenames that have space

I tried to run command siteit --input Silver Blaze.txt and got the following error messages:
-- ERROR Invalid or non-existing source supplied -- -- ERROR Invalid or non-existing source supplied --

The tool doesn't generate output after creation of output folder.

Operating Environment

Operation System: Windows 10
Node version: v16.13.2

Issue

As expected, the tool creates a dist output folder when it doesn't’ exist, but it should also proceed to generate output files in the folder. Instead, the output folder is empty.
Enter command and output:
image

Expected Behaviour

The tool generates output after creation of output folder.

The tool reports an issue when reading a single txt file as input.

Operating Environment

Operation System: Windows 10
Node version: v16.13.2

Issue

The tool reports an issue when reading a single txt file as input.
Entered command and output:
image

What’s in the test folder:
image

Expected Behaviour

The tool accepts a single txt file as input and produces a html file as output.

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.