Static websites with python
Project description
Mophidian - A python based SSG
Use markdown to create websites
Notes
Mophidian has markdown code highlighting with the markdown.codehilite plugin and pygmentize. In the background mophidian runs a command similar to pygmentize -S <theme> -f html -a .highlight > styles/highlight.css which build the specified theme into a css file. Use moph highlight <theme> to generate a theme or moph highlight to get a list of available themes.
The core ideas behind this SSG/framework is the same as all the large Javascript frameworks. So in a way, if you used any type of Javascript framework, then this project should be fairly easy to learn.
The documentation includes guides for:
- Basic phml templating. Refer to the phml documentation for more in depth guides.
- Python's markdown module and how it is integrated with Mophidian
- How the live reload server works and what to expect
- Markdown flavor guide (Specific to the default markdown plugins in this SSG)
Planned Features:
- site-map
- live reloading server
- components
- templating
- searching
- presets
- tool to build codehilite themes
Rules and how things work
File Structure
Mophidian uses a custom language called phml. This language was inspired by javascript frameworks similar to Vue.js. The language support python blocks inside <python> tags and inline python for conditions and in replacements. With this phml also has a built in component system. This works how you think it would in other javascript languages. You just need to load the component into the compiler then you can use the component anywhere in your phml code.
A simple phml page may look something like this.
<!-- index.phml -->
<!DOCTYPE html>
<html>
<head>
<title>Example</title>
</head>
<body>
<h1>Hello World</h1>
</body>
</html
Which ends up looking exactly the same when it is compiled to html. Phml allows users to pass in extra variables into the compiler which will be exposed to the phml file as it is being compiled/rendered. You can compare this to something similar to Jinja2 and how it handles data.
Here is an example of how Jinja2 handles variables and how it uses them.
from jinja2 import Environment
env = Environment()
template = env.get_template("sample.html")
template.render(variables="go", here=True, errors=["er1", "er2"])
<!-- sample.html -->
<!DOCTYPE html>
<html>
<head>
<title>{{ variables }}</title>
</head>
<body>
{% if here %}
<p>Right here</p>
{% else %}
<p>Not Here</p>
{% endif %}
<ul>
{% for error in errors %}
<li>{{ error }}</li>
{% endfor %}
</ul>
</body>
</html>
Phml is similar in some way. Below is how the same example is written in phml.
from phml import PHML
phml = PHML()
phml.load("sample.phml")
phml.render(variables="go", here=True, errors=["er1", "er2"])
# or with shorthand
phml.load("sample.phml").render(variables="go", here=True, errors=["er1", "er2"])
<!-- sample.phml -->
<!DOCTYPE html>
<html>
<head>
<title>{{ variables }}</title>
</head>
<body>
<p @if="here">Right here</p>
<p @else>Not Here</p>
<ul>
<For :each="error in errors">
<li>{{ error }}</li>
</For>
</ul>
</body>
</html>
As seen above both are very similar while phml is simplier to write. Phml also has the benifit of using python itself instead of a python like syntax. Also loops retain context so any nested loop using a value from the outer scope won't break.
If you want to know more about phml check out it's documentation
Mophidian also has built in markdown support. Markdown plugins can be added and modified through Mophidian's configuration file. On top of the plugins Mophidian allows for use of phml components and the use of frontmatter.
Frontmatter is yaml at the start of the file. The parsed values are passed to the markdown pages layout and can be used in rendering a page.
---
title: Sample Markdown Page
tags: ['markdown', 'example']
---
# Example Markdown
hello world
This above example will use title for the page title. If it isn't present then it will parse the h1 element, # Example Markdown, and finally if that is also missing, the markdown file name is used.
You may have noticed that it was mentioned that markdown files use layout pages. These are pages named layout.phml. These layouts are expected to be structured like a phml component and it must contain a <Slot /> component. Any file that uses this layout will have it's context placed in place of the <Slot /> component.
<!-- layout.phml -->
<>
<h1>{{ title }}</h1>
<Slot />
</>
Pages inside of mophidian are similar to layouts where they are phml components. This allows for pages to be placed inside of layouts and layout can be placed inside of other layouts. All pages have the name of page.phml with an optional layout name seen as page@{layout}.phml. See the File System section to see how this works.
<!-- page.phml -->
<python>
# Any python code goes here. Indentation is based on the first line with text
message = "Hello World"
</python>
<!-- The wrapping component can be an empty tag or any
other element but there must be only one content element -->
<>
<p>Hello World</p>
<a href="/">Home</>
</>
<script>
// Any script logic here
</script>
<style>
/* Any css styles here */
</style>
At the root of rendering a page in Mophidian there is a base layout which fills in the structure of an html page. ```html
<title>{{ title or '' }}</title> ```All nested layouts and the page are put into their appropriate slot and then eventually placed in the <Slot /> element in the base layout. To add any other element to the <head /> tag just use the head tag again in a layout or page. Mophidian will take all elements from these duplicate head tags and put them in the base tag. All duplicate tags are ignored. Special tags like title are replace when they are duplicated.
<!-- page.phml -->
<>
<head>
<title>Example</title>
</head>
<p>This is a sample page</p>
</>
File System
The file system is structured based on javascript libraries like Astro.js. It looks something like this.
project
├ moph.yml
├ public/
│ └ */**/*.*
└ src/
├ components/
│ └ */**/.phml
└ pages/
├ */**/*.md
├ */**/page.phml
└ */**/layout.phml
As you can see above there are three primary objects in the root project directory. moph.yml is used for the Mophidian configuration. public/ is where static assets are placed. All files and directories are one-to-one to the root of the server. src/ is where all pages, components, layouts, and additional static files are placed.
Components are placed into their own subdirectory, src/components/ and each file is a phml component. All components file names are used for the component name. For example, if you have a file named Callout.phml the component can be used with <Callout />. Components in subdirectories have their parent directories appended to the name recursively with each name being seperated with a dot. This can look something like this, header/Nav.phml, which will expose a component to use that looks like this, <Header.Nav />.
Page, layout, and markdown files are placed into the src/pages directory. There can only be one layout.phml and page.phml per directory. There can be any number of markdown files per directory, with README.md being equivelant to a page.phml page. Any layout in the same directory as a page.phml or markdown file with be used for that file. If there is a layout missing from the current directory, then the next parent directories layout is used. This is recursive up until the base layout.
Mophidian supports groups. These are directories with the syntax of (group name). This is a psuedo directory and is used to name a layout that is in that directory. The layout inside the root of a group inherits it's name. All other files and directories are treated as if they are located in the next parent directory. With the layout inheriting the groups name, all page.phml and markdown files can skip it's default assigned layout and use a specific layout. For example if you have the following file structure.
...
└ src/
└ pages/
├ (blog)
│ ├ layout.phml
│ └ page.phml
└ about/
└ page@blog.phml
The page.phml file inside the about/ directory with use the layout from the (blog) group. The file structure is treated like it looks like this.
...
└ src/
└ pages/
├ layout.phml < has a layout name of blog
├ page.phml
└ about/
└ page@blog.phml
This file system logic is heavily inspired by Svelte Kit. More about how this all works is in the Mophidian documentation.
Features
Mophidian comes with many quality of life features with more on the way. Some of notable features include: helper methods, value shorthands, live reloading, and a CLI tool.
Helper Methods
blank(value): Checks if the value isNone,False, or empty. Currently support lists, sets, tuples, and dicts for checking if emptyclassnames: Works the same as Vue.js built in classlist attribute. It allows for conditional classes, and listing classes. Exampleclassnames('red', {'bold': is_bold}, ['underline', {'left-0': lalign}])filter_sort(collection, filter, key): Both filters and sorts a list without calling multiple methods. Uses pythons built infilterandsortedmethods. First it will filter by the passed filter argument, then it will sort the collection by the passed key argument.
Value Shorthands
@at the start ofsrcandhrefhtml attributes. The@is replaced with the servers root so you don't have to type it out every time.
Live Reloading
Mophidian uses a custom library call watchserver which is built to automatically handle live reloading pages. It works by determining if it is serving an html page. If it is then it inserts a script that polls the server on a specific endpoint and checks if the current page should be refreshed. The endpoint either response with a truthy response or a falsy one. The server determines if a page should be reloaded based on if it's path fits a file pattern created by a file watch event. I recommend looking at the watchserver documentation for more information on how this works.
CLI Tool
Mophidian comes with a cli tool called moph. This tool comes with the ability to: create a new project, build a project, build and serve a project, build and preview a project, and generate pygmentize css.
For more information about Mophidian, check out the documentation
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
File details
Details for the file mophidian-0.2.4.tar.gz.
File metadata
- Download URL: mophidian-0.2.4.tar.gz
- Upload date:
- Size: 717.1 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/4.0.1 CPython/3.11.1
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | 0ea4d3f8b295030231a0b430f3da26c501b6bda21947245b30ae9b62ee64b1c7 |
|
| MD5 | c8ad49ee9ec8c862115d5a23c3304b16 |
|
| BLAKE2b-256 | 931f84c9d751b65ebfd9f8c9c72f69d837deaa9d08682280abbe4023f3865f3d |
File details
Details for the file mophidian-0.2.4-py3-none-any.whl.
File metadata
- Download URL: mophidian-0.2.4-py3-none-any.whl
- Upload date:
- Size: 139.0 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/4.0.1 CPython/3.11.1
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | 2ad439ab7846ec14cb0e257f20567a327e78d8be4ab9389b49eb1041e30c68ca |
|
| MD5 | cfc712291f3fb851f30c56be94fdcd63 |
|
| BLAKE2b-256 | d5d79ead81a7e5b777b101bf704523d4572b53e770a8d57b4add51dfe7fde84a |
