strawberries/wiki-maker
1
1
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

fixed and improved images, and generalized renderer

Browse Source
This commit is contained in:
eiiko6
2026-02-26 09:06:06 +01:00
parent 20e944912f
commit b854e4b633
9 changed files with 126 additions and 103 deletions
Download Patch File Download Diff File Expand all files Collapse all files

1
.gitignore vendored
View File

@@ -3,3 +3,4 @@
/result
/example/*.html
/example/*.css
/dist

48
Cargo.lock generated
View File

@@ -252,9 +252,9 @@ checksum = "613afe47fcd5fac7ccf1db93babcb082c5994d996f20b8b159f2ad1658eb5724"
[[package]]
name = "chrono"
version = "0.4.43"
version = "0.4.44"
source = "registry+https://github.com/rust-lang/crates.io-index"
checksum = "fac4744fb15ae8337dc853fee7fb3f4e48c0fbaa23d0afe49c447b4fab126118"
checksum = "c673075a2e0e5f4a1dde27ce9dee1ea4558c7ffe648f576438a20ca1d2acc4b0"
dependencies = [
"iana-time-zone",
"js-sys",
@@ -440,9 +440,9 @@ dependencies = [
[[package]]
name = "deranged"
version = "0.5.7"
version = "0.5.8"
source = "registry+https://github.com/rust-lang/crates.io-index"
checksum = "2163a0e204a148662b6b6816d4b5d5668a5f2f8df498ccbd5cd0e864e78fecba"
checksum = "7cd812cc2bc1d69d4764bd80df88b4317eaef9e773c75226407d9bc0876b211c"
dependencies = [
"powerfmt",
]
@@ -1032,9 +1032,9 @@ dependencies = [
[[package]]
name = "js-sys"
version = "0.3.87"
version = "0.3.90"
source = "registry+https://github.com/rust-lang/crates.io-index"
checksum = "93f0862381daaec758576dcc22eb7bbf4d7efd67328553f3b45a412a51a3fb21"
checksum = "14dc6f6450b3f6d4ed5b16327f38fed626d375a886159ca555bd7822c0c3a5a6"
dependencies = [
"once_cell",
"wasm-bindgen",
@@ -1389,9 +1389,9 @@ dependencies = [
[[package]]
name = "pulldown-cmark"
version = "0.13.0"
version = "0.13.1"
source = "registry+https://github.com/rust-lang/crates.io-index"
checksum = "1e8bbe1a966bd2f362681a44f6edce3c2310ac21e4d5067a6e7ec396297a6ea0"
checksum = "83c41efbf8f90ac44de7f3a868f0867851d261b56291732d0cbf7cceaaeb55a6"
dependencies = [
"bitflags",
"getopts",
@@ -1579,9 +1579,9 @@ dependencies = [
[[package]]
name = "regex-syntax"
version = "0.8.9"
version = "0.8.10"
source = "registry+https://github.com/rust-lang/crates.io-index"
checksum = "a96887878f22d7bad8a3b6dc5b7440e0ada9a245242924394987b21cf2210a4c"
checksum = "dc897dd8d9e8bd1ed8cdad82b5966c3e0ecae09fb1907d58efaa013543185d0a"
[[package]]
name = "reqwest"
@@ -1645,9 +1645,9 @@ checksum = "357703d41365b4b27c590e3ed91eabb1b663f07c4c084095e60cbed4362dff0d"
[[package]]
name = "rustls"
version = "0.23.36"
version = "0.23.37"
source = "registry+https://github.com/rust-lang/crates.io-index"
checksum = "c665f33d38cea657d9614f766881e4d510e0eda4239891eea56b4cadcf01801b"
checksum = "758025cb5fccfd3bc2fd74708fd4682be41d99e5dff73c377c0646c6012c73a4"
dependencies = [
"aws-lc-rs",
"once_cell",
@@ -2476,9 +2476,9 @@ dependencies = [
[[package]]
name = "wasm-bindgen"
version = "0.2.110"
version = "0.2.113"
source = "registry+https://github.com/rust-lang/crates.io-index"
checksum = "1de241cdc66a9d91bd84f097039eb140cdc6eec47e0cdbaf9d932a1dd6c35866"
checksum = "60722a937f594b7fde9adb894d7c092fc1bb6612897c46368d18e7a20208eff2"
dependencies = [
"cfg-if",
"once_cell",
@@ -2489,9 +2489,9 @@ dependencies = [
[[package]]
name = "wasm-bindgen-futures"
version = "0.4.60"
version = "0.4.63"
source = "registry+https://github.com/rust-lang/crates.io-index"
checksum = "a42e96ea38f49b191e08a1bab66c7ffdba24b06f9995b39a9dd60222e5b6f1da"
checksum = "8a89f4650b770e4521aa6573724e2aed4704372151bd0de9d16a3bbabb87441a"
dependencies = [
"cfg-if",
"futures-util",
@@ -2503,9 +2503,9 @@ dependencies = [
[[package]]
name = "wasm-bindgen-macro"
version = "0.2.110"
version = "0.2.113"
source = "registry+https://github.com/rust-lang/crates.io-index"
checksum = "e12fdf6649048f2e3de6d7d5ff3ced779cdedee0e0baffd7dff5cdfa3abc8a52"
checksum = "0fac8c6395094b6b91c4af293f4c79371c163f9a6f56184d2c9a85f5a95f3950"
dependencies = [
"quote",
"wasm-bindgen-macro-support",
@@ -2513,9 +2513,9 @@ dependencies = [
[[package]]
name = "wasm-bindgen-macro-support"
version = "0.2.110"
version = "0.2.113"
source = "registry+https://github.com/rust-lang/crates.io-index"
checksum = "0e63d1795c565ac3462334c1e396fd46dbf481c40f51f5072c310717bc4fb309"
checksum = "ab3fabce6159dc20728033842636887e4877688ae94382766e00b180abac9d60"
dependencies = [
"bumpalo",
"proc-macro2",
@@ -2526,18 +2526,18 @@ dependencies = [
[[package]]
name = "wasm-bindgen-shared"
version = "0.2.110"
version = "0.2.113"
source = "registry+https://github.com/rust-lang/crates.io-index"
checksum = "e9f9cdac23a5ce71f6bf9f8824898a501e511892791ea2a0c6b8568c68b9cb53"
checksum = "de0e091bdb824da87dc01d967388880d017a0a9bc4f3bdc0d86ee9f9336e3bb5"
dependencies = [
"unicode-ident",
]
[[package]]
name = "web-sys"
version = "0.3.87"
version = "0.3.90"
source = "registry+https://github.com/rust-lang/crates.io-index"
checksum = "f2c7c5718134e770ee62af3b6b4a84518ec10101aad610c024b64d6ff29bb1ff"
checksum = "705eceb4ce901230f8625bd1d665128056ccbe4b7408faa625eec1ba80f59a97"
dependencies = [
"js-sys",
"wasm-bindgen",

0
example/bernardo.png → example/images/bernardo.png
View File

Side by Side Swipe Overlay

Before

Width:  |  Height:  |  Size: 52 KiB

After

Width:  |  Height:  |  Size: 52 KiB

4
src/cli.rs
View File

@@ -26,8 +26,8 @@ pub enum Commands {
Build {
#[arg(short, long)]
no_navigation: bool,
#[arg(short, long)]
out_dir: Option<PathBuf>,
#[arg(short, long, default_value = "dist")]
out_dir: PathBuf,
},
/// Output a DOT graph of the wiki connections
Graph {},

66
src/codeblocks.rs
View File

@@ -1,66 +0,0 @@
use pulldown_cmark::{CodeBlockKind, CowStr, Event, Parser as MarkdownParser, Tag, TagEnd};
use pulldown_cmark_escape::escape_html;
use syntect::html::highlighted_html_for_string;
use crate::{SYNTAX_SET, THEME_SET};
// I found this at <https://github.com/pulldown-cmark/pulldown-cmark/issues/167#issuecomment-3700787117>
pub struct CodeblockRenderer<'a> {
inner: MarkdownParser<'a>,
}
impl<'a> CodeblockRenderer<'a> {
pub fn new(inner: MarkdownParser<'a>) -> Self {
Self { inner }
}
}
impl<'a> Iterator for CodeblockRenderer<'a> {
type Item = Event<'a>;
fn next(&mut self) -> Option<Self::Item> {
let event = self.inner.next()?;
// Intercept CodeBlock starts
let Event::Start(Tag::CodeBlock(kind)) = event else {
return Some(event);
};
let mut code_content = String::new();
while let Some(inner_event) = self.inner.next() {
match inner_event {
Event::End(TagEnd::CodeBlock) => break,
Event::Text(code) => code_content.push_str(&code),
_ => {}
}
}
let lang = match kind {
CodeBlockKind::Indented => "text",
CodeBlockKind::Fenced(ref language) => language.as_ref(),
};
let rendered_html = render_code_to_html(&code_content, lang);
let mut escaped_code = String::new();
let _ = escape_html(&mut escaped_code, &code_content);
let rendered_html =
rendered_html.replace("<pre", &format!("<pre data-code=\"{}\"", escaped_code));
Some(Event::Html(CowStr::Boxed(rendered_html.into_boxed_str())))
}
}
pub fn render_code_to_html(code: &str, lang: &str) -> String {
let syntax = SYNTAX_SET
.find_syntax_by_token(lang)
.unwrap_or_else(|| SYNTAX_SET.find_syntax_plain_text());
let theme = &THEME_SET.themes["Catppuccin Macchiato"];
highlighted_html_for_string(code, &SYNTAX_SET, syntax, theme)
.unwrap_or_else(|_| format!("<pre><code>{}</code></pre>", code))
}

12
src/entry.rs
View File

@@ -58,10 +58,11 @@ async fn list_entries(root: &PathBuf) -> Result<()> {
fn check_file_status(root: &PathBuf, filename: Option<String>) -> String {
match filename {
Some(f) => {
if root.join(&f).exists() {
let path = root.join("images").join(&f);
if path.exists() {
f.green().to_string()
} else {
format!("{} (Missing)", f.red())
format!("{} (Missing in images/)", f.red())
}
}
None => "None".to_string(),
@@ -88,6 +89,9 @@ async fn create_entry(root: &PathBuf, title: &str) -> Result<()> {
let toml_path = root.join(&toml_filename);
let md_path = root.join(&md_filename);
let images_dir = root.join("images");
fs::create_dir_all(&images_dir).await?;
if toml_path.exists() {
return Err(anyhow!("Entry '{}' already exists", slug));
}
@@ -119,7 +123,7 @@ content_file = "{}"
println!("Created entry '{}'", title);
println!(" - TOML: {:?}", toml_path);
println!(" - Markdown: {:?}", md_path);
println!(" - (Expected image: {:?})", img_filename);
println!(" - (Expected image: {:?})", images_dir.join(img_filename));
Ok(())
}
@@ -151,7 +155,7 @@ async fn remove_entry(root: &PathBuf, name: &str) -> Result<()> {
let p = root.join(&img_file);
if p.exists() {
fs::remove_file(&p).await?;
println!("Removed: {}", img_file);
println!("Removed: images/{}", img_file);
}
}

23
src/main.rs
View File

@@ -13,7 +13,6 @@ use tera::{Context, Tera};
mod analysis;
mod cli;
mod codeblocks;
mod entry;
mod rendering;
@@ -99,6 +98,10 @@ async fn main() -> anyhow::Result<()> {
.route("/", get(render_summary_handler))
.route("/{page}", get(render_page_handler))
.route("/style.css", get(serve_css))
.nest_service(
"/images",
tower_http::services::ServeDir::new(&shared_state.docs_dir.join("images")),
)
.nest_service(
"/assets",
tower_http::services::ServeDir::new(&shared_state.docs_dir),
@@ -118,7 +121,7 @@ async fn main() -> anyhow::Result<()> {
no_navigation,
out_dir,
} => {
let output_path = out_dir.unwrap_or_else(|| abs_path.clone());
let output_path = out_dir;
tokio::fs::create_dir_all(&output_path).await?;
run_build(abs_path, output_path, no_navigation).await?;
}
@@ -206,6 +209,22 @@ async fn run_build(docs_dir: PathBuf, out_dir: PathBuf, no_navigation: bool) ->
}
}
let out_images = out_dir.join("images");
tokio::fs::create_dir_all(&out_images).await?;
let src_images = docs_dir.join("images");
if src_images.exists() {
let mut entries = tokio::fs::read_dir(&src_images).await?;
while let Some(entry) = entries.next_entry().await? {
tracing::info!("Copied {}", entry.file_name().display(),);
let path = entry.path();
if path.is_file() {
let dest = out_images.join(path.file_name().unwrap());
tokio::fs::copy(path, dest).await?;
}
}
}
let mut entries = tokio::fs::read_dir(&docs_dir).await?;
while let Some(entry) = entries.next_entry().await? {
let path = entry.path();

73
src/rendering.rs
View File

@@ -3,15 +3,78 @@ use axum::{
http::StatusCode,
response::{Html, IntoResponse},
};
use pulldown_cmark::{Options, Parser as MarkdownParser, html};
use pulldown_cmark::{
CodeBlockKind, CowStr, Event, Options, Parser as MarkdownParser, Tag, TagEnd, html,
};
use pulldown_cmark_escape::escape_html;
use std::path::PathBuf;
use std::sync::Arc;
use syntect::html::highlighted_html_for_string;
use tera::Context;
use crate::{
AppState, TEMPLATES, WikiConfig, codeblocks::CodeblockRenderer, get_nav_links, get_summary_data,
AppState, SYNTAX_SET, TEMPLATES, THEME_SET, WikiConfig, get_nav_links, get_summary_data,
};
pub struct Renderer<'a> {
inner: MarkdownParser<'a>,
}
impl<'a> Renderer<'a> {
pub fn new(inner: MarkdownParser<'a>) -> Self {
Self { inner }
}
}
impl<'a> Iterator for Renderer<'a> {
type Item = Event<'a>;
fn next(&mut self) -> Option<Self::Item> {
let event = self.inner.next()?;
// Intercept CodeBlock starts
let Event::Start(Tag::CodeBlock(kind)) = event else {
return Some(event);
};
let mut code_content = String::new();
while let Some(inner_event) = self.inner.next() {
match inner_event {
Event::End(TagEnd::CodeBlock) => break,
Event::Text(code) => code_content.push_str(&code),
_ => {}
}
}
let lang = match kind {
CodeBlockKind::Indented => "text",
CodeBlockKind::Fenced(ref language) => language.as_ref(),
};
let rendered_html = render_code_to_html(&code_content, lang);
let mut escaped_code = String::new();
let _ = escape_html(&mut escaped_code, &code_content);
let rendered_html =
rendered_html.replace("<pre", &format!("<pre data-code=\"{}\"", escaped_code));
Some(Event::Html(CowStr::Boxed(rendered_html.into_boxed_str())))
}
}
pub fn render_code_to_html(code: &str, lang: &str) -> String {
let syntax = SYNTAX_SET
.find_syntax_by_token(lang)
.unwrap_or_else(|| SYNTAX_SET.find_syntax_plain_text());
let theme = &THEME_SET.themes["Catppuccin Macchiato"];
highlighted_html_for_string(code, &SYNTAX_SET, syntax, theme)
.unwrap_or_else(|_| format!("<pre><code>{}</code></pre>", code))
}
#[derive(serde::Serialize)]
struct InfoboxItem {
key: String,
@@ -64,7 +127,7 @@ pub async fn render_wiki_page(
);
let parser = MarkdownParser::new_ext(&markdown_content, options);
let renderer = CodeblockRenderer::new(parser);
let renderer = Renderer::new(parser);
let mut html_output = String::new();
html::push_html(&mut html_output, renderer);
@@ -93,11 +156,13 @@ pub async fn render_wiki_page(
None => Vec::new(),
};
let main_image_path = config.image.as_ref().map(|img| format!("images/{}", img));
let mut context = Context::new();
context.insert("title", &config.title);
context.insert("content", &html_output);
context.insert("infobox", &infobox_list);
context.insert("main_image", &config.image);
context.insert("main_image", &main_image_path);
context.insert("prev_page", &prev);
context.insert("next_page", &next);
context.insert("no_navigation", &no_navigation);

2
templates/page.html
View File

@@ -15,7 +15,7 @@
<aside class="wiki-sidebar">
{% if main_image %}
<div class="sidebar-image">
<img src="{% if is_static %}{{ main_image }}{% else %}assets/{{ main_image }}{% endif %}" alt="{{ title }}">
<img src="{{ main_image }}" alt="{{ title }}">
</div>
{% endif %}