~codersonly/transmogrifier

A static website generator
deno reformat
reenable the first fixture based test
simplify the basic tests

refs

master
browse  log 

clone

read-only
https://git.sr.ht/~codersonly/transmogrifier
read/write
git@git.sr.ht:~codersonly/transmogrifier

You can also use your local clone with git send-email.

#Transmogrifier by Coders Only

Transmogrifier by Coders Only, a static website generator, is a collaborative effort by the members of the Coders Only software craft community. We're grateful for all individual contributions but attribute the entire project to the community.

The primary goal of Transmogrifier is to allow us migrate our website away from WordPress. This will drive the required features. A secondary objective is to use this product as exercise ground for our various workshops, such as our TDD Demystified series.

Any questions or feedback, hit us up.

#Getting Started

Transmogrifier works by reading a directory with the sources of website and generating another directory that can then be uploaded to a web server.

#Requirements

You'll only need the Deno runtime. Install it the most convenient way.

#Installation

Download (or clone) the repository and place it in a cozy spot in your file system. Then, for best results, add the .../bin folder to the system PATH.

#Usage

Coming soon...

#Documentation

Here we detail all supported functionalities of Transmogrifier.

#Configuration

Coming soon...

#Simple Markup

Coming soon...

#Advanced Features

Coming soon...

#Special Characters

Coming soon...

#Architecture Decision Records

Here we add a few notes on why certain things turned out this way.

#Why TypeScript on Deno

Because we needed a language that's fairly standard, lightweight and relevant. We want to use the project for exercises in our workshops and the lower the barrier to entry, the more interesting the concepts, the better it will be for participants. The lightweight requirement disqualified compiled languages, the standard eliminated the (lovely but) exotic ones, so with TypeScript being an ideal candidate, the existence of the amazing new Deno runtime won the race.

But for completeness' stake, beside TypeScript the other candidates mulled over were Odin, Lua, Pike, V, Elixir and Crystal.

#No External Dependencies

This being a command line tool, despite the purpose of website generation, we want to stick to a strict "no further dependencies" policy, to the point of being able to run the tool offline. And keeping things simple we don't want to add a local package cache. Hence we shall stick to the inbuilt means of Deno. Also, to gain experience with whatever feats it has and what it's missing. Also, to see what does it take to fill those gaps. As mentioned before, learning exercise.

#Unix Derivatives Only

Yeah, sorry, we aren't going to deal with backslashes and drive letters and the rest of Redmond. If Transmogrifier is going to run in the Linux mode of Windows, we'll be glad, but if it won't... too bad.

#Creative Commons License

Transmogrifier by Coders Only is licensed under the GNU GENERAL PUBLIC LICENSE v3.

To view a copy of this license, visit https://www.gnu.org/licenses/gpl-3.0.html.

Transmogrifier by Coders Only, a static website generator

Copyright (C) 2021 Coders Only, https://codersonly.org

This program is free software: you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation, either version 3 of the License, or
(at your option) any later version.

This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
GNU General Public License for more details.

You should have received a copy of the GNU General Public License
along with this program.  If not, see <https://www.gnu.org/licenses/>.

All individual contributions are attributed to the Coders Only community.

#ZAP

The name Transmogrifier is with a nod, or rather, bow, to Calvin and Hobbes and their creator, Bill Watterson.

And "ZAP" comes from...

ZAP