amy/dragonglass
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

tiny bits of documentation

Browse Source
This commit is contained in:
Amy G. Bowersox 2024-08-28 00:20:59 -06:00
parent bb5d5ae14e
commit 00c9fc4369
2 changed files with 8 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

7
README.md
View File

@ -1,2 +1,9 @@
# dragonglass
This is a utility that turns an Obsidian stack into a directory of HTML pages
suitable for browsing or serving via a Web server. Markdown files are transformed
into HTML; other files are copied verbatim.
The name is derived from the Westerosi name of "obsidian," as seen in George R.R. Martin's
_A Song of Ice and Fire_ books and the _Game of Thrones_ TV series.

1
src/dragonglass/tree.py
View File

@ -180,6 +180,7 @@ def generate_list(ctxt: Any, source_root: Path) -> list[SourceNode]:
Generates the list of source nodes from the source path (Obsidian vault).
Args:
ctxt (Context): Context for the operation.
source_root (Path): The root directory (Obsidian vault) to load nodes from.
Returns: