-
Notifications
You must be signed in to change notification settings - Fork 1
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
feat: adding guidelines and tutorials from doxygen (before, it was ge…
…nerated under /impl), and adding the playground as iframes on the language tutorial page
- Loading branch information
Showing
25 changed files
with
1,972 additions
and
555 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -8,3 +8,5 @@ man/ | |
|
||
/*.html | ||
tutorials/*.html | ||
guidelines/*.html | ||
implementation/*.html |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -4,9 +4,9 @@ This repository is hosting the presentation and documentation of the language. | |
|
||
## A brief tour | ||
|
||
The website is generated in root folder through Pug, allowing us to easily split the code for each pages and reuse components. | ||
The website is generated in root folder through Pug, allowing us to easily split the code for each page and reuse components. | ||
|
||
Install NodeJS avec then Pug with `npm i`. The run `node main.js` to generate the HTML files. You can start a webserver with `python3 -m http.server`. | ||
Install Node.js then Pug with `npm i`. The run `node main.js` to generate the HTML files. You can start a webserver with `python3 -m http.server`. | ||
|
||
### Language presentation | ||
|
||
|
@@ -16,7 +16,7 @@ The tutorials (understanding the language, and how to build the language) are un | |
|
||
### ArkScript source code documentation | ||
|
||
This one is automatically generated through Doxygen by our development team, under `impl/`. Do not modify this folder as every changes will get erased by Doxygen each time we regenerate the documentation. | ||
This one is automatically generated through Doxygen by our development team, under `impl/`. Do not modify this folder as every change will get erased by Doxygen each time we regenerate the documentation. | ||
|
||
The Doxyfile for this is in the [core repository](https://github.com/ArkScript-lang/Ark). | ||
|
||
|
@@ -27,6 +27,10 @@ This is automatically regenerated every day at 00:00 by a GitHub action on this | |
## Contributing | ||
|
||
* First, [fork](https://github.com/ArkScript-lang/arkscript-lang.github.io/fork) the repository | ||
* Then, clone your fork: `git clone [email protected]:username/arkscript-lang.github.io.git` | ||
* Then, clone your fork: `git clone [email protected]:username/website.git` | ||
* Create a branch for your feature: `git checkout -b feat-my-awesome-idea` | ||
* When you're done, push it to your fork and submit a pull request! | ||
* When you're done, push it to your fork and submit a pull request! | ||
|
||
### Development | ||
|
||
You can use `nodemon -w views -e pug main.js` alongside a `python3 -m http.server` so that files are updated immediately when modified, without having to launch `main.js` and boot yet another webserver. |
Oops, something went wrong.