UnifyJustTheDocs

Create a single Markdown file from a Jekyll web site built with the just-the-docs theme.

TL;DR

Use the composite function to create a markdown string with the complete content of the sample Jekyll site in this repository's test/data/samplesite directory:

samplesite = joinpath(repositoryroot, "test", "data", "samplesite")

using UnifyJustTheDocs
markdown = composite(samplesite)
typeof(markdown)

String

The first characters look like this:

print(markdown[1:103])

# Home page

This is the first page of the sample jekyll site.

It's the only file at the root level

What it does

Patrick Marsceill's just-the-docs Jekyll theme creates clean, easily navigated web sites with minimal configuration. Files can be arbitrarily named and kept in directories to any depth of nested subdirectories. The structure of the web site is determined by a combination of YAML settings organizing pages' navigation order in up to three hierarchical levels.UnifyJustTheDocs recursively reads all .md files in a file system, and uses just-the-docs's conventions to sequence pages from the files' YAML settings. The composite function (illustrated above) concatenates the markdown content of all the files into a single string which you could then use to do things like typeset a PDF with pandoc.

Documentation

This documentation was built using Documenter.jl.

Documentation built 2023-08-12T16:09:45.629 with Julia 1.8.5 on Linux