yagigreg/historian
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Initial commit of historian web application

Browse Source
This commit is contained in:
Captain Beyond
2024-08-03 06:10:53 -05:00
parent fa2c8ee85a
commit c18ae34880
18 changed files with 5354 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

9
README.md
View File

@@ -1 +1,10 @@
# Historian
Historian is a hybrid wiki and static site generator.
More broadly, Historian aims to present a git repository of Markdown files as a web-editable wiki, which can be exported into a static site. As such, Historian tries not to introduce its own special syntax or conventions. A Historian wiki should be editable and previewable in any Markdown editor, and should be usable as a wiki or documentation site in e.g. a GitHub or Gitea repo.
That being said Historian does also include some helper tools to make management of such a wiki easier, for example, it includes a tool to resolve MediaWiki style [[wikilinks]] into a markdown links. These tools can be used both on the command line and in the Historian web interface.
The Historian web interface is a very simple wiki interface that provides an editor and a page history view. It does not currently do authentication; it's intended exclusively as an internal wiki.
A search functionality is planned but not implemented. Ideally it would be possible to include the search component as part of the statically built website, perhaps by compiling a search index along with the website contents.