- HTML 79.6%
- Awk 13%
- Shell 7.4%
stringbone
5676387380
* Improve clarity in the readme file for users. * Add more FLAIR to the example pages. * Some small accessibility improvements to use of `-block-start/end` instead of `-bottom/top` Co-authored-by: Milo Fultz <milopfultz@gmail.com> Reviewed-on: #3 |
||
|---|---|---|
| src | ||
| _footer.phtml | ||
| _header.phtml | ||
| andres.jpg | ||
| bichipoo.jpg | ||
| CHANGELOG.md | ||
| contact.html | ||
| contact.phtml | ||
| hampster.gif | ||
| index.gmi | ||
| index.html | ||
| links.html | ||
| links.phtml | ||
| README.md | ||
| stone.mp3 | ||
COLLAGE
Make your website like you used to with Neopets, Myspace, and all that good stuff.
For every .phtml ("partial HTML") or .gmi (gemtext) file in a given directory, take the header, the given file, and the footer and paste into a file with the same name and an extension of .html.
You can see a very rudimentary example scrapped together here.
If you are a little more tech savvy, you can easily extend the shell scripts to build a site out of whatever files, like markdown or Kaku. Check out the build scripts to extend it further!
How to use it
- Create pages by making or editing
phtmlofgmifiles (read more about thegmiformat here). These will be converted tohtmlfiles with your header and footer files attached. For instance, if you make a file namedlinks.gmiorlinks.phtml, it will be converted intolinks.html. - If you want content at the top or bottom of every page (e.g. a heading), put that after the
<body>tag in your_header.phtmland/or before the</body>tag in the_footer.phtmlfiles. - If you want to style your pages, you can either use inline styling (if using
phtml), the<style>tag in the header file, or by loading in acssfile using the<link rel="stylesheet">tag. - When you are ready to build your website, open the
src/build_all.shfile in your terminal to build all the files. You may need to right click and select "Open with", and open the script with the "Terminal" app. - Upload the outputted
htmlfiles and any media files you are using to your hosting service using Cyberduck, Filezilla, or your host's platform.
Render options
In the src/build.sh file, there is a small section at the top of user options. Setting the value after the = sign to true or false will affect the final build.
Tips for a great website
- Every page should start with an
h1element that is the focus of your page, and all other headings should be nested properly. (Why?) - Use HTML elements with the appropriate semantics:
<blockquote>for quotes,<strong>for bolded text,<em>for emphasized text, etc. This makes styling super simple and makes your site more accessible to all users. If your HTML is good and accurate, your users will thank you! - I've added some utility classes to the header file to style your text. You can find them in the
<style>tag at the top of the_header.phtmlfile. - Don't add Javascript to your page unless you really need it! There is currently one script in the template that is used for updating the site title based on your current page to improve accessibility, but if you don't know what you are doing, scripts can create security problems for you and your visitors. Especially don't add
<script>tags you find on other websites! - Have fun!
Why?
I have a friend who wanted to make their own website. I thought Lichen would be perfect, but unfortunately their server wasn't going to work. THey liked the Neopets/Myspace days, so I thought I'd give them the barebones way to build their own site:
- Make a header
- Make a footer
- Make some pages
- Run a script
- Transfer files onto the server via FTP