1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
|
use std::collections::BTreeMap;
use std::path::Path;
use tools::println_cargo_style;
const PAGES_ROOT: &str = "./docs/pages";
const SIDEBAR_PATH: &str = "./docs/_sidebar.md";
const SIDEBAR_HEAD: &str = "- [Welcome!](README)\n";
fn main() {
println_cargo_style!("Refresh: _sidebar.md");
gen_sidebar();
gen_translation_sidebars();
}
/// Generate _sidebar.md for the primary language
fn gen_sidebar() {
let repo_root = find_git_repo().unwrap();
let pages_root = repo_root.join(PAGES_ROOT);
let lines = build_sidebar_content(&repo_root.join("docs"), &pages_root, SIDEBAR_HEAD);
let sidebar_path = repo_root.join(SIDEBAR_PATH);
std::fs::write(&sidebar_path, lines).unwrap();
println_cargo_style!("Generated: {}", sidebar_path.display());
}
/// Generate _sidebar.md inside translation directories
fn gen_translation_sidebars() {
let repo_root = find_git_repo().unwrap();
let docs_root = repo_root.join("docs");
if let Ok(read_dir) = std::fs::read_dir(&docs_root) {
for entry in read_dir.flatten() {
let path = entry.path();
let file_name = entry.file_name().to_string_lossy().to_string();
// Only process entries starting with '_' that are directories
if file_name.starts_with('_') && path.is_dir() {
// Check if this directory has a 'pages' subdirectory
let pages_dir = path.join("pages");
if !pages_dir.exists() || !pages_dir.is_dir() {
continue;
}
// The _sidebar.md for a translation directory is relative to that directory,
// so strip_prefix should use the translation directory path, removing the _zh_CN/ prefix
let lines = build_sidebar_content(&path, &pages_dir, "- [Welcome!](README)\n");
let sidebar_path = path.join("_sidebar.md");
std::fs::write(&sidebar_path, lines).unwrap();
println_cargo_style!("Generated: {}", sidebar_path.display());
}
}
}
}
/// Build sidebar content: scan .md files in pages_dir and return a formatted sidebar string
fn build_sidebar_content(base_dir: &Path, pages_dir: &Path, sidebar_head: &str) -> String {
let mut lines = String::from(sidebar_head);
// Collect and sort entries at root level first
let mut root_files: Vec<SidebarEntry> = Vec::new();
// Subdirectory name -> its files
let mut sub_dirs: BTreeMap<String, Vec<SidebarEntry>> = BTreeMap::new();
if let Ok(read_dir) = std::fs::read_dir(pages_dir) {
for entry in read_dir.flatten() {
let path = entry.path();
if path.is_dir() {
let dir_name = entry.file_name().to_string_lossy().to_string();
let entries = collect_markdown_files(&path, base_dir);
if !entries.is_empty() {
sub_dirs.insert(dir_name, entries);
}
} else if path.extension().is_some_and(|ext| ext == "md") {
let title = extract_title(&path);
let relative = path
.strip_prefix(base_dir)
.unwrap()
.to_string_lossy()
.replace('\\', "/");
let link = relative
.strip_suffix(".md")
.unwrap_or(&relative)
.to_string();
root_files.push(SidebarEntry { title, link });
}
}
}
// Sort root files by link for stable order
root_files.sort_by(|a, b| a.link.cmp(&b.link));
// Append root-level files
for f in &root_files {
lines.push_str(&format!("* [{}]({})\n", f.title, f.link));
}
// Append subdirectory groups
for (dir_name, entries) in &sub_dirs {
let mut sorted_entries = entries.clone();
sorted_entries.sort_by(|a, b| a.link.cmp(&b.link));
// Directory header with 2-space indent
lines.push_str(&format!("* {}\n", dir_name));
for f in &sorted_entries {
lines.push_str(&format!(" * [{}]({})\n", f.title, f.link));
}
}
lines
}
#[derive(Clone)]
struct SidebarEntry {
title: String,
link: String,
}
/// Collect all `.md` files directly under `dir`
fn collect_markdown_files(dir: &Path, base_dir: &Path) -> Vec<SidebarEntry> {
let mut entries = Vec::new();
if let Ok(read_dir) = std::fs::read_dir(dir) {
for entry in read_dir.flatten() {
let path = entry.path();
if path.extension().is_some_and(|ext| ext == "md") {
let title = extract_title(&path);
let relative = path
.strip_prefix(base_dir)
.unwrap()
.to_string_lossy()
.replace('\\', "/");
let link = relative
.strip_suffix(".md")
.unwrap_or(&relative)
.to_string();
entries.push(SidebarEntry { title, link });
}
}
}
entries
}
/// Extract title from the first line `<h1 align="center">TITLE</h1>`.
/// Fallback to filename stem.
fn extract_title(path: &Path) -> String {
let content = std::fs::read_to_string(path).unwrap_or_default();
if let Some(first_line) = content.lines().next() {
let trimmed = first_line.trim();
// Find `>TITLE<` between `<h1 align="center">` and `</h1>`
if let Some(start) = trimmed.find('>') {
let after_start = &trimmed[start + 1..];
if let Some(end) = after_start.find('<') {
return after_start[..end].to_string();
}
}
}
// Fallback: use file stem
path.file_stem()
.map(|s| s.to_string_lossy().to_string())
.unwrap_or_else(|| "Untitled".to_string())
}
fn find_git_repo() -> Option<std::path::PathBuf> {
let mut current_dir = std::env::current_dir().ok()?;
loop {
let git_dir = current_dir.join(".git");
if git_dir.exists() && git_dir.is_dir() {
return Some(current_dir);
}
if !current_dir.pop() {
break;
}
}
None
}
|
