Skip to content

Home

Jump to bottom
Kai edited this page Mar 19, 2020 · 5 revisions

Welcome to the Ruskko wiki!

This is Ruskko, an HTML5 framework trying to make HTML easy, and smarter. To use Ruskko you need to know a few things.

|Syntax | File Structure | Using Ruskko | Versioning |

Some other basic information before you start:

  • Dependencies
    • Python 3.7.5 or higher
    • (Optional but Recommended): A web browser
  • Known Issues:
    • None At This time
  • Contributing
    • Issues:
      • To submit an issue, please use the proper [labels[(https://github.com/KaiLyons/Ruskko/labels) to keep things in an easy-to-work-with situation
      • If we deny your request once, please do not recreate it. If your issue was closed in error, please use that tag when re-opening it, and describe why it is in error.
    • Commits and adding code:
      • To add any code you will have to fork the repository and create a merge request.

Syntax

In Ruskko, the syntax follows the same path as HTML, and plain HTML is allowed. However to avoid error, as this has not been set up to detect it yet, do not use or the tags, as they are added automatically by the program. All HTML syntax works, including doing classes and IDs. Custom tags will also be applicable.

Ruskko also has comments. To create a comment you just do // followed by your comment. Do note this takes up the entire line.

File-Structure

Ruskko files are created in a .rsko file. Ruskko files are structured almost the exact same way as HTML files. Here is a basic Ruskko page:

// index.rsko
<head>
    <title>My First Ruskko Page!</title>
</head>
<body>
    <h1>This is Ruskko</h1>
    <p>This page was made using the <a href="https://github.com/KaiLyons/Ruskko">Ruskko HTML Framework</a>!</p>
</body>

Notice that there is no HTML tags, those are done automatically in the file creation process of Ruskko.

Using-Ruskko

How to run this file properly can be found on the README.md file

How-Versioning-Works

split up as such:

(early/full).(featureset_ver).(bug_fix_ver)

So version 2.4.1 is: Full Release 2, Feature Set 4, Bug Fix 1 and version 0.2.0 is: Early Release, Feature Set 2, No Bug Fixes.

For a beta of a release, it will be in RTC. So RTC3.5.2 is Build for 3, Feature Set 5, Bug Fix 2.

RTC releases ALWAYS will lead to their respective early/full release. So RTC3.9.1 if complete will be 3.0.0.

Clone this wiki locally