diff --git a/_wiki/Main.md b/_wiki/Main.md index 1c9c4c1..af5d971 100644 --- a/_wiki/Main.md +++ b/_wiki/Main.md @@ -1,258 +1,126 @@ --- layout: simple -title: Main Page -created: 2009-04-12 -modified: 2009-04-12 +title: Main_Page revisions: -- author: Alexis - date: 2009-04-12 +- author: Cuu + date: 2024-02-22 comment: First version --- - -# Why ? - -I wrote this template in 2019 because I wanted to migrate a mediawiki-powered wiki to jekyll. - -The template has a layout and a navigation that can replace my old wiki. - -# How to - -If you want to use this template, clone the [repository](https://github.com/jek4wik/jek4wik), customize it and write _wiki_ pages. - -## Settings - -The general settings are in the _config.yml file. - -You may choose the *language*. -English (en) and french (fr) are supported out-of-the box. - -```yaml -lang: en -``` - -You may customize the *collections*. -The only contraint is that the name of collections containing wiki pages should start with wiki. - -```yaml -collections: - wiki-one: - output: true - permalink: "/:path" - path: "" - wiki-two: - output: true - permalink: "/:path" - path: "" - special: - output: true - permalink: "/:path" - path: "" -``` - -Of course, you'll have to change the other site settings like title, description or url. - -## i18n - -The labels are in i18n files in the `_data/i18n` directory. - -These files contain also prefixes for special pages, the name of home page and the logo that will be displayed on the top left. - -```yaml -home: Main -logo: /img/wiki.png -label: - author: Author - links: Links - tags: Other pages - ... -prefix: - tag: "Category:" - user: "User:" -``` - -## Users - -The users are declared in the _data/users.yml file. - -```yaml -Alexis: - name: Alexis Hassler - logo: img/sewatech.png -``` - -Each user should have its page in the `_special` directory. -The name of this page starts with the prefix defined in the i18n file (here `User:`) -and end with the user short name (here `Alexis`). - -# Wiki pages - -Wiki pages are in collections that name starts with wiki. -The bootstrap project provides 2 collections : `wiki` and `wiki-legacy`. - -The pages can be written in HTML, Markdown or Asciidoc. - -> Note: Asciidoc is not supported on Github pages. - -## Regular wiki page - -A regular wiki page should be place in a _wiki_ collection. -The only required metadata in frontmatter is the layout. -The simplest page may be something like this: - -```yaml ---- -layout: wiki ---- -Example with minimal frontmatter -``` - -The frontmatter may contain the following attributes: - -* title: will be displayed on top of the page -* author: will be displayed in a div in the left columns -* toc: true/false wether you want a generated table of content -* created and modified: date in format yyyy-MM-dd -* revisions: not displayed (maybe for a future use) - -> Note: the toc plugin doesn't work on Github pages - -## Redirect page - -A redirect page should be place in the _special_ collection. -It should have a frontmatter with a **layout** and a **redirect**, and no content - -```yaml ---- -layout: redirect -redirect: New ---- -``` - -> Note: redirections may be managed in an other way with the _jekyll-redirect-from_ plugin - -## Tag page - -A tag page should be place in a _special_ collection. -The file name should have the prefix defined in the _i18n_ file and end with the tag name. - -For example, a file named `Tag:Example.md` would fit with the following i18n configuration. - -```yaml -prefix: - tag: "Tag:" -``` - -> Note: this is in the i18n files because mediawiki translates this prefix ; it is Category in english and Catégorie in french - -The tag page may have the same metadata as a regular page. - -```yaml ---- -layout: tag -title: Example of Tag -tags: Example -toc: false -created: 2019-04-12 -modified: 2019-04-12 -revisions: -- author: Alexis - date: 2019-04-12 - comment: First version ---- -## Example Tag - -Nice examples -``` - -## User pages - -A user page should be place in a _special_ collection. -The file name should have the prefix defined in the _i18n_ file and end with the user name. - -For example, a file named `User:Example.md` would fit with the following i18n configuration. - -```yaml -prefix: - user: "User:" -``` - -> Note: this is in the i18n files because mediawiki translates this prefix ; it is User in english and Utilisateur in french - -The user page may have the same metadata as a regular page. - -```yaml ---- -layout: user -title: Alexis -created: 2019-04-12 -modified: 2019-04-12 ---- -I'm a developer. -``` - -# Deploy - -The simplest way to deploy your wiki is to generate the site and copy it to a Web Server. - -```yaml -jekyll build -``` - -As any Jekyll web site, the generation may be done on a CI server (TravisCI,...) or with the CI capabilities of the Git server (Gitlab, Github actions,...). - -## Apache HTTP server - -A `.htaccess` file is provided. -If the site is deployed on a Apache HTTP server, some old mediawiki URLs are rewritten to the new Jekyll URLs. - -## Github pages - -The wiki cannot be deloyed simply on Github pages because of unsupported filters and custom plugins. - -If you want to deploy it on Github pages, you should push the generated site. -Any CI tool can help. - -## Gitlab pages / CI - -If your source code is hosted on Gitlab, you can deploy the wiki on Gitlab page. -The .gitlab-ci.yml provides a generic setup for that. -When you push on Gitlab, the file is be detected and a pipeline is run. -The wiki is then deployed on pages. - -> Note: the deployment may occur several minutes after the end of the build. - -With the provided configuration, Gitlab CI may also upload the site with SFTP. - -Reference: - -* [GitLab Pages](https://docs.gitlab.com/ee/user/project/pages/) - - -## Github actions - -[TBD] - -## TravisCI - -[Travis CI](https://travis-ci.org/) can launch automatically the jekyll build and deploy the site. - -The examples and this page are built this way. -The [repository](https://github.com/jek4wik/jek4wik) provides a `.travis.yml` configuration file wich deploy the built site on Github Pages. -If want to use it, just change the `repo` and setup your build on Travis CI with the GITHUB_TOKEN environment variable. - -With the provided configuration, Travis CI may also upload the site with SFTP. - -References: - -* [Travis CI - GitHub Pages Deployment](https://docs.travis-ci.com/user/deployment/pages/) -* [Travis CI - Script deployment](https://docs.travis-ci.com/user/deployment/script/) - -# Examples - -* Example of a [new page](New) -* Example of a [legacy page](Old) -* Example of a [redirected page](Redirect) -* Example of a [user page](./User:Alexis) -* [RSS](feed.xml) feed of new pages -* Example of a [tag page](./Tag:Example) -* [All tags page](./tags) +Welcome to the ClockworkPi community wiki! + +## Gameshell + +### What is GameShell? + +GameShell is an open source portable game console made by +[ClockworkPi](https://www.clockworkpi.com/) after a successful +[Kickstarter +campaign](https://www.kickstarter.com/projects/954662076/gameshell-redefine-retro-game-console) +in 2018. + +
+ +
GameShell_W.png
+
+ +### Getting started + +- [Assembly](Assembly "wikilink") - Follow the assembly manual came with + GameShell to assemble the parts. +- [Up and Running](Up_and_Running "wikilink") - You've assembled your + GameShell and powered it on, now what? +- [SSH](SSH "wikilink") - Connect GameShell with your computer for + transferring files and configurations. +- [Emulators](Emulators "wikilink") - How to configure your emulators + and how to add ROMs. +- [Pico-8](Pico-8 "wikilink") - How to install Pico-8, a cute fantasy + console on your GameShell. +- [Troubleshooting](Troubleshooting "wikilink") - Launcher not loading? + Cannot connect to WiFi? Check here for solutions to common problems. +- [Glossary](Glossary "wikilink") - Learn the jargons! +- [Linux resources](Linux_resources "wikilink") - New to Linux? Don't + panic! + +### Hardware + +- [GameShell hardware info](GameShell_hardware_info "wikilink") - + Information about GameShell's mainboard, screen, battery, keypad, + speaker and Lightkey module +- [GPIO](GPIO "wikilink") - Interact with the real world with General + Purpose Input/Output lines! +- [3D Models](3D_Models "wikilink") - 3D models of GameShell parts for + 3D printing, including community designed custom parts. +- [Bluetooth](Bluetooth "wikilink") - Connect other devices using + bluetooth + +### Software + +- [Kernel](Kernel "wikilink") - CPI Linux Kernel +- [Launcher](Launcher "wikilink") - The launcher of games and apps in + GameShell +- [Warehouse](Warehouse "wikilink") - Libraries of browsable and + downloadable games, like those developed in [GameShell + Jams](GameShell_Jams "wikilink") +- [Compatible emulators](Compatible_emulators "wikilink") - NES, SNES, + Genesis/MD, PS1, you name it! +- [Compatible game engines](Compatible_game_engines "wikilink") - + Pygame, LÖVE2D, Pico-8, Tic-80... +- [Compatible games](Compatible_games "wikilink") - List of standalone + games such as CaveStory, ChocoDM. + +## DevTerm + +### What is DevTerm? + +Devterm is an open source portable terminal for every Dev! + +
+ +
DevTerm_fig01.webp
+
+ +### Getting started + +[Assembly](Devterm_Assembly "wikilink") - Follow the assembly manual +came with DevTerm to assemble the parts. + +[Batteries](Batteries "wikilink") - The 18650 batteries are NOT included +in the package due to global logistics complexity for lithium batteries + +### Hardware + +- [Devterm hardware info](Devterm_hardware_info "wikilink") - + Information about DevTerm's mainboard, screen, battery, keyboard, and + speaker modules +- [GPIO](GPIO "wikilink") - Interact with the real world with General + Purpose Input/Output lines! +- [3D Models](3D_Models "wikilink") - 3D models of DevTerm parts for 3D + printing, including community designed custom parts. +- [Bluetooth](Bluetooth "wikilink") - Connect other devices using + bluetooth +- [EXT.](EXT. "wikilink") - Connect devices via the (non-standard) + mPCI-E slot +- [CORE](CORE "wikilink") - Info about the CORE modules +- [Thermal Printer](Thermal_Printer "wikilink") - Print out your .TXT's + on the built-in printer! + +### Software + +- [Kernel](Kernel "wikilink") - CPI Linux Kernel +- [ClockworkOS](ClockworkOS "wikilink") - The operating system for your + DevTerm + +### Howtos + +- [Manjaro on A06](Manjaro_on_A06 "wikilink") - Install Manjaro OS on + DevTerm A06 +- [How-Tos and Tweaks](How-Tos_and_Tweaks "wikilink") + +## Community + +- [Forum](https://forum.clockworkpi.com/) +- [Discord](https://discord.gg/XKGGkPM) +- [Github](https://github.com/clockworkpi) +- [Twitter](https://twitter.com/Hal_clockwork) +- [Instagram](https://instagram.com/clockworkpi/) +- [GameShell Jams](GameShell_Jams "wikilink") diff --git a/_wiki/Main_Page.md b/_wiki/Main_Page.md deleted file mode 100644 index af5d971..0000000 --- a/_wiki/Main_Page.md +++ /dev/null @@ -1,126 +0,0 @@ ---- -layout: simple -title: Main_Page -revisions: -- author: Cuu - date: 2024-02-22 - comment: First version ---- -Welcome to the ClockworkPi community wiki! - -## Gameshell - -### What is GameShell? - -GameShell is an open source portable game console made by -[ClockworkPi](https://www.clockworkpi.com/) after a successful -[Kickstarter -campaign](https://www.kickstarter.com/projects/954662076/gameshell-redefine-retro-game-console) -in 2018. - -
- -
GameShell_W.png
-
- -### Getting started - -- [Assembly](Assembly "wikilink") - Follow the assembly manual came with - GameShell to assemble the parts. -- [Up and Running](Up_and_Running "wikilink") - You've assembled your - GameShell and powered it on, now what? -- [SSH](SSH "wikilink") - Connect GameShell with your computer for - transferring files and configurations. -- [Emulators](Emulators "wikilink") - How to configure your emulators - and how to add ROMs. -- [Pico-8](Pico-8 "wikilink") - How to install Pico-8, a cute fantasy - console on your GameShell. -- [Troubleshooting](Troubleshooting "wikilink") - Launcher not loading? - Cannot connect to WiFi? Check here for solutions to common problems. -- [Glossary](Glossary "wikilink") - Learn the jargons! -- [Linux resources](Linux_resources "wikilink") - New to Linux? Don't - panic! - -### Hardware - -- [GameShell hardware info](GameShell_hardware_info "wikilink") - - Information about GameShell's mainboard, screen, battery, keypad, - speaker and Lightkey module -- [GPIO](GPIO "wikilink") - Interact with the real world with General - Purpose Input/Output lines! -- [3D Models](3D_Models "wikilink") - 3D models of GameShell parts for - 3D printing, including community designed custom parts. -- [Bluetooth](Bluetooth "wikilink") - Connect other devices using - bluetooth - -### Software - -- [Kernel](Kernel "wikilink") - CPI Linux Kernel -- [Launcher](Launcher "wikilink") - The launcher of games and apps in - GameShell -- [Warehouse](Warehouse "wikilink") - Libraries of browsable and - downloadable games, like those developed in [GameShell - Jams](GameShell_Jams "wikilink") -- [Compatible emulators](Compatible_emulators "wikilink") - NES, SNES, - Genesis/MD, PS1, you name it! -- [Compatible game engines](Compatible_game_engines "wikilink") - - Pygame, LÖVE2D, Pico-8, Tic-80... -- [Compatible games](Compatible_games "wikilink") - List of standalone - games such as CaveStory, ChocoDM. - -## DevTerm - -### What is DevTerm? - -Devterm is an open source portable terminal for every Dev! - -
- -
DevTerm_fig01.webp
-
- -### Getting started - -[Assembly](Devterm_Assembly "wikilink") - Follow the assembly manual -came with DevTerm to assemble the parts. - -[Batteries](Batteries "wikilink") - The 18650 batteries are NOT included -in the package due to global logistics complexity for lithium batteries - -### Hardware - -- [Devterm hardware info](Devterm_hardware_info "wikilink") - - Information about DevTerm's mainboard, screen, battery, keyboard, and - speaker modules -- [GPIO](GPIO "wikilink") - Interact with the real world with General - Purpose Input/Output lines! -- [3D Models](3D_Models "wikilink") - 3D models of DevTerm parts for 3D - printing, including community designed custom parts. -- [Bluetooth](Bluetooth "wikilink") - Connect other devices using - bluetooth -- [EXT.](EXT. "wikilink") - Connect devices via the (non-standard) - mPCI-E slot -- [CORE](CORE "wikilink") - Info about the CORE modules -- [Thermal Printer](Thermal_Printer "wikilink") - Print out your .TXT's - on the built-in printer! - -### Software - -- [Kernel](Kernel "wikilink") - CPI Linux Kernel -- [ClockworkOS](ClockworkOS "wikilink") - The operating system for your - DevTerm - -### Howtos - -- [Manjaro on A06](Manjaro_on_A06 "wikilink") - Install Manjaro OS on - DevTerm A06 -- [How-Tos and Tweaks](How-Tos_and_Tweaks "wikilink") - -## Community - -- [Forum](https://forum.clockworkpi.com/) -- [Discord](https://discord.gg/XKGGkPM) -- [Github](https://github.com/clockworkpi) -- [Twitter](https://twitter.com/Hal_clockwork) -- [Instagram](https://instagram.com/clockworkpi/) -- [GameShell Jams](GameShell_Jams "wikilink")