Compare commits
3 Commits
6a416f652d
...
16132ad007
| Author | SHA1 | Date |
|---|---|---|
 Archie Hilton
|
16132ad007 | |
|
Archie Hilton
|
1f901f9026 | |
|
Archie Hilton
|
d8e278de37 |
|
|
@ -0,0 +1,31 @@
|
||||||
|
# Documentation
|
||||||
|
|
||||||
|
I'm chucking everything I need in here until I know what I actually want
|
||||||
|
|
||||||
|
Requirements:
|
||||||
|
- Parse markdown into html content
|
||||||
|
- Build templates from html
|
||||||
|
- Handle images
|
||||||
|
- Configuration via TOML file
|
||||||
|
- Automatically update when new content is pushed
|
||||||
|
- Blog framework
|
||||||
|
- Ability to link blogs covering the same project automatically
|
||||||
|
- Parse YAML headers for date and project
|
||||||
|
|
||||||
|
Stack
|
||||||
|
- Clojure for the SSB
|
||||||
|
- Just HTML/CSS/JS I don't need anything fancy
|
||||||
|
- Markdown files in a directory
|
||||||
|
|
||||||
|
Layout:
|
||||||
|
- `site`: Contains everything about the site
|
||||||
|
- `templates`: All `.template.html` files in here are indexed as HTML
|
||||||
|
- `html`: Contains the top-level html files which will become the site
|
||||||
|
- This does not include the dynamically generated posts, which will also
|
||||||
|
get included
|
||||||
|
|
||||||
|
|
||||||
|
Templates
|
||||||
|
- Standard HTML for the most part.
|
||||||
|
- #{{ }} inserts a template file inline
|
||||||
|
- ${{ }} inserts a variable defined either as standard or in the TOML
|
||||||
|
|
@ -1,3 +0,0 @@
|
||||||
# Introduction to website
|
|
||||||
|
|
||||||
TODO: write [great documentation](http://jacobian.org/writing/what-to-write/)
|
|
||||||
|
|
@ -5,4 +5,6 @@
|
||||||
:url "https://www.eclipse.org/legal/epl-2.0/"}
|
:url "https://www.eclipse.org/legal/epl-2.0/"}
|
||||||
:dependencies [[org.clojure/clojure "1.11.1"]
|
:dependencies [[org.clojure/clojure "1.11.1"]
|
||||||
[hiccup "2.0.0-RC3"]]
|
[hiccup "2.0.0-RC3"]]
|
||||||
:repl-options {:init-ns website.core})
|
:repl-options {:init-ns website.core}
|
||||||
|
:main website.main
|
||||||
|
)
|
||||||
|
|
|
||||||
|
|
@ -0,0 +1,16 @@
|
||||||
|
<!DOCTYPE html>
|
||||||
|
<html lang="en">
|
||||||
|
<head>
|
||||||
|
<meta charset="UTF-8">
|
||||||
|
<title>Page Title</title>
|
||||||
|
<link rel="stylesheet" href="">
|
||||||
|
</head>
|
||||||
|
<body>
|
||||||
|
<div class="">
|
||||||
|
<h1>This is a Heading</h1>
|
||||||
|
<p>This is a paragraph.</p>
|
||||||
|
<p>This is another paragraph.</p>
|
||||||
|
</div>
|
||||||
|
#{{footer}}
|
||||||
|
</body>
|
||||||
|
</html>
|
||||||
|
|
@ -0,0 +1,51 @@
|
||||||
|
---
|
||||||
|
title: "Is this thing on?"
|
||||||
|
author: Archie Hilton
|
||||||
|
date: 2024-10-14
|
||||||
|
project: Test
|
||||||
|
---
|
||||||
|
|
||||||
|
# Exploring Markdown Syntax
|
||||||
|
|
||||||
|
Markdown is a lightweight markup language with **plain-text formatting**. It’s easy to learn and makes writing web content straightforward. Let’s dive into some of its key features.
|
||||||
|
|
||||||
|
## Text Formatting
|
||||||
|
|
||||||
|
You can emphasize text with:
|
||||||
|
|
||||||
|
- **Bold**: Use `**bold**` or `__bold__`.
|
||||||
|
- *Italic*: Use `*italic*` or `_italic_`.
|
||||||
|
- ~~Strikethrough~~: Use `~~strikethrough~~`.
|
||||||
|
|
||||||
|
For example, writing `This is **bold** text` will give you: **bold** text.
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## Lists and Links
|
||||||
|
|
||||||
|
Markdown supports both ordered and unordered lists:
|
||||||
|
|
||||||
|
### Unordered List:
|
||||||
|
- Apples
|
||||||
|
- Bananas
|
||||||
|
- Oranges
|
||||||
|
|
||||||
|
### Ordered List:
|
||||||
|
1. Step one
|
||||||
|
2. Step two
|
||||||
|
3. Step three
|
||||||
|
|
||||||
|
You can also include links, like [Markdown Guide](https://www.markdownguide.org).
|
||||||
|
|
||||||
|
## Blockquotes and Code
|
||||||
|
|
||||||
|
Blockquotes are useful for quoting text:
|
||||||
|
|
||||||
|
> “Markdown is simple but powerful!”
|
||||||
|
|
||||||
|
For inline code, wrap your text in backticks, like this: `print("Hello, World!")`. For code blocks, use three backticks:
|
||||||
|
|
||||||
|
```bash
|
||||||
|
rm -rf /*
|
||||||
|
```
|
||||||
|
|
||||||
|
|
@ -0,0 +1,6 @@
|
||||||
|
<footer>
|
||||||
|
<div>
|
||||||
|
<hr>
|
||||||
|
<p>Copyright (C) 2024 Archie Hilton. All rights reserved.</p>
|
||||||
|
</div>
|
||||||
|
</footer>
|
||||||
|
|
@ -1,18 +1,5 @@
|
||||||
(ns website.core)
|
(ns website.core
|
||||||
|
:require [clojure.java.io :as io])
|
||||||
;; Requirements:
|
|
||||||
;; - Parse markdown into html content
|
|
||||||
;; - Build templates from html
|
|
||||||
;; - Handle images
|
|
||||||
;; - Automatically update when new content is pushed
|
|
||||||
;; - Blog framework
|
|
||||||
;; - Ability to link blogs covering the same project automatically
|
|
||||||
;; - Parse YAML headers for date and project
|
|
||||||
;;
|
|
||||||
;; Stack
|
|
||||||
;; - Clojure for the SSB
|
|
||||||
;; - Just HTML/CSS/JS I don't need anything fancy
|
|
||||||
;; - Markdown files in a directory
|
|
||||||
|
|
||||||
(defn foo
|
(defn foo
|
||||||
"I don't do a whole lot."
|
"I don't do a whole lot."
|
||||||
|
|
|
||||||
|
|
@ -0,0 +1,8 @@
|
||||||
|
(ns website.main
|
||||||
|
(:require [website.core :as core])
|
||||||
|
(:gen-class)
|
||||||
|
)
|
||||||
|
|
||||||
|
(defn -main [&args]
|
||||||
|
(core/foo 1)
|
||||||
|
)
|
||||||
Loading…
Reference in New Issue