I just download the latest release 0.4.1 (mdzk_0.4.1_x86_64-pc-windows-gnu.zip). The download was blocked by threat protection of Windows 10.

I'm using the latest Windows 10 build including the latest updates for threat protection.

I also tried download release 0.4.0. Same effect.

Any idea why this could be happening?

This sadly has to be done because some options logically belong to other tables. These need to be moved:

• ignore from [mdzk] to [build]
• backlinks-header from [mdzk] to [style]
• generate-summary from [mdzk] to [build]
• Fold options from [output.html] to [style]

For example, a note with a title How to Take Smart Notes (2017) by Sönke Ahrens was referred in another note as [[How to Take Smart Notes (2017) by Sönke Ahrens]], but it is parsed as <span class="missing-link" style="color:darkred;">How to Take Smart Notes</span> in the HTML generated by mdzk.

I'm not sure if I am using the library correctly. When I insert a wikilink to an image the output is noted in mdzk as a missing link. You can see an example here.

For now I am hard coding img tags. Am I doing something incorrect or the syntax is different? It works in obsidian but when I publish it doesn't come out as knowing about the image.

![[Bins/Images/WardleyMapBlank.png]]
 [![[Bins/Images/Wardley_Pioneers-Settlers-Town_Planners.jpg]]](https://blog.gardeviance.org/2015/04/the-only-structure-youll-ever-need.html)

<img src="/Bins/Images/Wardley_Pioneers-Settlers-Town_Planners.jpg">

I would like to use mdbook-toc to automatically add table of contents to my notes, but when I set it inside as a preprocessor it breaks mdzk parsing (backlinks doesn't work, metadata on top of notes doesn't get parsed).

Is there a way to make them both work together?

Current configuration:

[mdzk]
authors = ["author"]
ignore = []
language = "en"
multilingual = false
src = "notes"
title = "mdzk"
backlinks-header = "Backlinks"

[build]
create-missing = false
build-dir = "book"

[output.html]
no-section-label = true

[output.html.print]
enable = false

[output.html.fold]
enable = true
level = 1

[preprocessor.toc]
command = "mdbook-toc"
renderer = ["html"]

Signed-off-by: Matteo Joliveau [email protected]

Motivation

Ability to export all the metadata from the front matter to be processed by downstream tools

Linked Issues/PRs/Discussions

Closes #101

Motivation

There was an issue with the LaTeX rendering.

The problem was with pulldown_cmark. It sometimes splits the Text event into several pieces. When the split occurs inside a LaTeX entry, the entry is split into two and it is not converted into KaTeX. The best way to solve this is by using a new function that clears up the buffer until it sees an unmatched $ sign.

Another problem that causes this issue is that the Text event does not contain the links as-is. So when there is a link like

[Some Text](link.md)

The buffer only has Some Text. Because of this, running ch.content.replacen() does not work since the buffer does not have the identical string as ch.content.

Evidences

Linked Issues/PRs/Discussions

#62

In Hugo, for example, _index is the markdown folder representative, on GitHub it's README.

The current behaviour raises a warning duplicated page title found: .../_index.md. The current behavior shows _index as a sibling document.

Just a little note to help anyone that uses it, since the project does not have a documentation, yet the mention to the init command helps compare mdbook config to mdzk, with special attention that without the head [mdzk] we get a:

thread 'main' panicked at 'called `Result::unwrap()` on an `Err` value: Unable to represent the item as a JSON Value

Caused by:
    unsupported None value', src/config.rs:63:14
note: run with `RUST_BACKTRACE=1` environment variable to display a backtrace

   Compiling mdzk v0.3.5
error[E0658]: use of unstable library feature 'osstring_ascii'
  --> /root/.cargo/registry/src/github.com-1ecc6299db9ec823/mdzk-0.3.5/src/utils.rs:61:31
   |
61 |                 a.file_name().to_ascii_uppercase().cmp(&b.file_name().to_ascii_uppercase())
   |                               ^^^^^^^^^^^^^^^^^^
   |
   = note: see issue #70516 <https://github.com/rust-lang/rust/issues/70516> for more information

error[E0658]: use of unstable library feature 'osstring_ascii'
  --> /root/.cargo/registry/src/github.com-1ecc6299db9ec823/mdzk-0.3.5/src/utils.rs:61:71
   |
61 |                 a.file_name().to_ascii_uppercase().cmp(&b.file_name().to_ascii_uppercase())
   |                                                                       ^^^^^^^^^^^^^^^^^^
   |
   = note: see issue #70516 <https://github.com/rust-lang/rust/issues/70516> for more information

error: aborting due to 2 previous errors

For more information about this error, try `rustc --explain E0658`.
error: could not compile `mdzk`

To learn more, run the command again with --verbose.
warning: build failed, waiting for other jobs to finish...
error: failed to compile `mdzk v0.3.5`, intermediate artifacts can be found at `/tmp/cargo-installOA68P1`

Caused by:
  build failed

Motivation

The idea of this PR is to improve the Nix support of our application.

• [x] GitHub Action to check if our package is building
• [x] An overlay with the newest version

mdzk fails when building on github actions and on my computer by cargo install

Default host: x86_64-unknown-linux-gnu
rustup home:  /home/runner/.rustup

stable-x86_64-unknown-linux-gnu (default)
rustc 1.65.0 (897e37553 2022-11-02)
/home/runner/.cargo/bin/rustup toolchain install stable
info: syncing channel updates for 'stable-x86_64-unknown-linux-gnu'
info: latest update on 2022-12-15, rust version 1.66.0 (69f9c33d7 2022-12-12)

    Compiling mdzk v0.5.2
  error[E0063]: missing field `extra_watch_dirs` in initializer of `mdbook::config::BuildConfig`
    --> /home/runner/.cargo/registry/src/github.com-1ecc6299db9ec823/mdzk-0.5.2/src/config/build.rs:36:9
     |
  36 |         Self {
     |         ^^^^ missing `extra_watch_dirs`
  
  error[E0609]: no field `livereload_url` on type `HtmlConfig`
    --> /home/runner/.cargo/registry/src/github.com-1ecc6299db9ec823/mdzk-0.5.2/src/renderer/mdzk_renderer.rs:95:51
     |
  95 |         if let Some(ref livereload) = html_config.livereload_url {
     |                                                   ^^^^^^^^^^^^^^ unknown field
     |
     = note: available fields are: `theme`, `default_theme`, `preferred_dark_theme`, `curly_quotes`, `mathjax_support` ... and 16 others
  
  Some errors have detailed explanations: E0063, E0609.
  For more information about an error, try `rustc --explain E0063`.
  error: could not compile `mdzk` due to 2 previous errors
  warning: build failed, waiting for other jobs to finish...
  error: failed to compile `mdzk v0.5.2`, intermediate artifacts can be found at `/tmp/cargo-installNcxbor`

Motivation

This PR has a rewrite of how wikilinks are handled, which allows users of the API to add their own handlers to get custom functionality.

Evidences

None yet

To do

• [x] Main proof-of-concept interface
• [x] Wikilink preprocessors and renderers
• [ ] New tests for wikilink parsing
• [ ] Revamp CommonMarkHandler to be more easily pluggable
• [ ] Write docs

Hi, it's me again!

Currently fn fix_link(dest: CowStr) -> CowStr converts markdown links from something/something.md to something/something.html. This makes it difficult to support clean URLs (aka /my/page instead of /my/page.html). In my case, I actually generate HTML files as independent index.html files in dedicated directories. For instance, this is the conversion my SSG performs:

| Source File | Generated File | Live URL | |:------------------------------:|:--------------------------:|:--------------:| | README.md | index.html | / | | an-article.md | an-article/index.html | /an-article | | a/nested/README.md | a/nested/index.html | /a/nested |

Proposed solution

Have the Vault accept an additional (optional) configuration flag that asks whether to generate clean URLs or not. Since the output of the actual HTML files is up to the caller, the only thing this flag does is change the behaviour of fix_link(). The flag can be false by default to keep the current behaviour as the default one.

/// Generate /my/page.html and /categories/README.html links. Default behaviour
mdzk::VaultBuilder::default().source(out_dir).clean_urls(false)


/// Generate /my/page and /categories links
mdzk::VaultBuilder::default().source(out_dir).clean_urls(true)

Currently, I worked around this by parsing the generated HTML and applying some heuristics based on the current note path, fixing relative links and cleaning up file extensions, but it's cumbersome (around 60 LOC of pretty inefficient string manipulation) and the built-in solution would be much cleaner and more efficient.

Alternatives I considered

One alternative would be to skip Note::as_html and implement Markdown parsing myself using pulldown-cmark. That could work, and I may have to do it anyway in the future for stuff like custom HTML nodes, but I still think this could be a useful feature for use-cases that do not require such fine-grained control over the parsed DOM.

With the current main (d061a140e9437973f54c261c6440883b1781854c), when I try to build a site, I get:

E TOML deserialize error: missing field `title` at line 1 column 1
  missing field `title` at line 1 column 1

I get this even if I reduce mdzk.toml to:

[mdzk]
title = "Title"

I feel like I'm missing something here. Is there an example of an mdzk.toml that works with the current code out there that I could look at?

Equal titles are allowed, as the IDs serve as the one truth to what note is which. However, ID lookup and internal link creation can be ambiguous when notes share an equal title. We need to determine how mdzk should handle this.

Currently, looking up an ambiguous title returns the last note walked. The walk happens randomly, so this behavior is not consistent, though it might be the best we can get without sacrificing performance. Giving the user a warning would likely be the most sensible solution.