language-servers/roc
1
0
Fork 0
mirror of https://github.com/roc-lang/roc.git synced 2025-07-24 15:03:46 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions 6

link fixes

Browse source
This commit is contained in:
Anton-4 2023-07-15 11:28:11 +02:00
parent 98d0742c62
commit e627a58b67
No known key found for this signature in database
GPG key ID: 0971D718C0A9B937
2 changed files with 16 additions and 17 deletions
Download patch file Download diff file Expand all files Collapse all files

32
crates/docs/src/lib.rs
View file

@ -21,6 +21,7 @@ const BUILD_DIR: &str = "./generated-docs";
const LINK_SVG: &str = include_str!("./static/link.svg");
pub fn generate_docs_html(root_file: PathBuf) {
let build_dir = Path::new(BUILD_DIR);
let loaded_module = load_module_for_docs(root_file);
@ -101,8 +102,8 @@ pub fn generate_docs_html(root_file: PathBuf) {
// Insert asset urls & sidebar links
let template_html = assets
.raw_template_html
.replace("<!-- search.js -->", "/search.js")
.replace("<!-- styles.css -->", "/styles.css")
.replace("<!-- search.js -->", "search.js")
.replace("<!-- styles.css -->", "styles.css")
.replace("<!-- favicon.svg -->", "/favicon.svg")
.replace(
"<!-- Prefetch links -->",
@ -110,7 +111,7 @@ pub fn generate_docs_html(root_file: PathBuf) {
.docs_by_module
.iter()
.map(|(_, module)| {
let href = module_link_url(module.name.as_str());
let href = module.name.as_str();
format!(r#"<link rel="prefetch" href="{href}"/>"#)
})
@ -118,6 +119,7 @@ pub fn generate_docs_html(root_file: PathBuf) {
.join("\n ")
.as_str(),
)
.replace("<!-- base -->", &base_url())
.replace(
"<!-- Module links -->",
render_sidebar(loaded_module.docs_by_module.values()).as_str(),
@ -188,10 +190,6 @@ pub fn generate_docs_html(root_file: PathBuf) {
println!("🎉 Docs generated in {}", build_dir.display());
}
fn module_link_url(module_name: &str) -> String {
format!("{}{}", base_url(), module_name)
}
fn page_title(package_name: &str, module_name: &str) -> String {
format!("<title>{module_name} - {package_name}</title>")
}
@ -203,12 +201,11 @@ fn render_package_index(root_module: &LoadedModule) -> String {
for module in root_module.docs_by_module.values() {
// The anchor tag containing the module link
let mut link_buf = String::new();
let href = module_link_url(module.name.as_str());
push_html(
&mut link_buf,
"a",
vec![("href", href.as_str())],
vec![("href", module.name.as_str())],
module.name.as_str(),
);
@ -235,6 +232,7 @@ fn render_module_documentation(
all_exposed_symbols: &VecSet<Symbol>,
) -> String {
let mut buf = String::new();
let module_name = module.name.as_str();
push_html(&mut buf, "h2", vec![("class", "module-name")], {
let mut link_buf = String::new();
@ -243,7 +241,7 @@ fn render_module_documentation(
&mut link_buf,
"a",
vec![("href", "/#")],
module.name.as_str(),
module_name,
);
link_buf
@ -256,12 +254,12 @@ fn render_module_documentation(
if all_exposed_symbols.contains(&doc_def.symbol) {
buf.push_str("<section>");
let name = doc_def.name.as_str();
let href = format!("#{name}");
let def_name = doc_def.name.as_str();
let href = format!("{module_name}#{def_name}");
let mut content = String::new();
push_html(&mut content, "a", vec![("href", href.as_str())], LINK_SVG);
push_html(&mut content, "strong", vec![], name);
push_html(&mut content, "strong", vec![], def_name);
for type_var in &doc_def.type_vars {
content.push(' ');
@ -278,7 +276,7 @@ fn render_module_documentation(
push_html(
&mut buf,
"h3",
vec![("id", name), ("class", "entry-name")],
vec![("id", def_name), ("class", "entry-name")],
content.as_str(),
);
@ -400,13 +398,13 @@ fn render_sidebar<'a, I: Iterator<Item = &'a ModuleDocumentation>>(modules: I) -
let mut buf = String::new();
for module in modules {
let href = module_link_url(module.name.as_str());
let href = module.name.as_str();
let mut sidebar_entry_content = String::new();
push_html(
&mut sidebar_entry_content,
"a",
vec![("class", "sidebar-module-link"), ("href", &href)],
vec![("class", "sidebar-module-link"), ("href", href)],
module.name.as_str(),
);
@ -418,7 +416,7 @@ fn render_sidebar<'a, I: Iterator<Item = &'a ModuleDocumentation>>(modules: I) -
if module.exposed_symbols.contains(&doc_def.symbol) {
let mut entry_href = String::new();
entry_href.push_str(href.as_str());
entry_href.push_str(href);
entry_href.push('#');
entry_href.push_str(doc_def.name.as_str());

1
crates/docs/src/static/index.html
View file

@ -6,6 +6,7 @@
<!-- Page title -->
<!-- <meta name="description" content="TODO populate this based on the module's description"> -->
<meta name="viewport" content="width=device-width">
<base href="<!-- base -->">
<script type="text/javascript" src="<!-- search.js -->" defer></script>
<link rel="icon" href="<!-- favicon.svg -->">
<link rel="stylesheet" href="<!-- styles.css -->">