Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
Frotty authored Mar 13, 2024
1 parent 58f72eb commit 515f34d
Showing 1 changed file with 4 additions and 11 deletions.
15 changes: 4 additions & 11 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,13 +5,11 @@ Live at https://wurstlang.org/

This folder contains the complete source of the WurstScript website, configured as jekyll project and deployed via github-pages.

The design is based on https://github.com/xriley/PrettyDocs-Theme

# Developer Information

## Serving the page locally:

1. Check whether you have Ruby 2.1.0 or higher installed:
1. Check whether you have Ruby 2.7.4 installed:

`ruby --version`

Expand All @@ -38,14 +36,9 @@ Tutorials are included as part of the documentation in their own section.

To create a new tutorial:

* Create a new table of contents file in `_doc/tutorials/`, for example `cp wurstbeginner.md new_tutorial.md`.
* Create a new set of tuturial pages in a subfolder of `_doc/tutorials/` - e.g. `cp -r wurstbeginner new_tutorial`.
* Define the pages by changing the contents of `_doc/tutorials/new_tutorial/` - usually one or two markdown files will suffice.
* Add the new tutorial to the tutorials listing in `_doc/tutorials.md` - just need to add a uri in the `navigation` section.
* Setup `new_tutorial.md` as necessary for your pages:
- Edit the title, excerpt, date, icon, color.
- Change the `sections` to match the uri of the pages of your tutorial.
* Write your tutorial pages, being sure to update the heading sections as necessary.
* Create a new markdown file in the `_tutorials/` folder, for example `cp saveload.md new_tutorial.md`.
* Adjust the frontmatter such as title, excerpt, date
* The tutorial will be automatically added to the documentation page, the sidebar is generated from markdown headings

## Standard library doc

Expand Down

0 comments on commit 515f34d

Please sign in to comment.