umca v0.8.0
Umca
Get started
The best way to begin developing with Umca is with npx:
npx umca create yourprojectname
cd yourprojectnameWhat Umca does and doesn't do
:white_check_mark: Takes JSX files that you wrote and compiles them into plain HTML
:white_check_mark: Automatically creates pages for (and only for) JSX files that are linked to with an <a> tag
:white_check_mark: Automatically adds prefetch hints to <head> if a page has internal links
:white_check_mark: Allows to import Markdown files from JSX files and automatically converts them to HTML
:white_check_mark: Comes with Tailwind CSS
:white_check_mark: Ships zero Javascript to the client
:x: Does not handle any user interactions. You have to bring your own JS
:x: Not an SPA (at least not yet)
Developing with Umca
- Run
yarn buildornpm buildto (re)compile your JSX - Run
yarn startornpm startto locally host thepublicfolder
/src
This is where all of your JSX files should be. Note that at least one of them must be named index.jsx, which is an entry file.
/pages
Umca allows you to import .md files right in your components. Put .md files in this folder.
CSS
Umca is equipped with Tailwind CSS. This means you only need to add existing (utility) classes to your elements and no CSS files are needed. This makes the framework highly opinionated. However, since pages are build with (reusable) components in Umca, you can both keep your design atomic AND avoid scope problems because all classes are just utilities.