Compare commits
38 Commits
python
...
68ad78e0a3
Author | SHA1 | Date | |
---|---|---|---|
68ad78e0a3
|
|||
f13dfc77f8
|
|||
2bcdde6341
|
|||
d9035f6f2f
|
|||
6f6df5fd07 | |||
3405ea2c4d | |||
014d72f39c | |||
0c5f367ceb | |||
8871faaef0 | |||
7654745cf0 | |||
1c72f127d3 | |||
94a047e51b | |||
78def54645 | |||
c8d70a3661 | |||
7bda685927 | |||
1386679c49 | |||
d6c9a8adab | |||
1d9245fb8f | |||
56688b26f5 | |||
7e85e2a1fa | |||
65e36de48c | |||
b6978bad9e | |||
f9ffd01d7c | |||
c51b8a302a | |||
3f50d9da28 | |||
51ba98f045 | |||
1e0135a8e5 | |||
d4de923f1e | |||
d77077f13d | |||
08b0037ee6 | |||
388c75b351 | |||
17fae8c60e | |||
89e5a1061a | |||
e7db61e551 | |||
42d0775fe6 | |||
700709f171 | |||
ca3baf0768 | |||
70d92e6d04 |
2
.gitignore
vendored
2
.gitignore
vendored
@@ -1,2 +1,4 @@
|
|||||||
*.swp
|
*.swp
|
||||||
env
|
env
|
||||||
|
n
|
||||||
|
web
|
||||||
|
4
Makefile
4
Makefile
@@ -1,9 +1,11 @@
|
|||||||
install:
|
install:
|
||||||
cp notes2web.py /usr/local/bin
|
cp notes2web.py /usr/local/bin
|
||||||
pip install -r requirements.txt
|
pip3 install -r requirements.txt
|
||||||
mkdir -p /opt/notes2web
|
mkdir -p /opt/notes2web
|
||||||
cp -r templates /opt/notes2web
|
cp -r templates /opt/notes2web
|
||||||
cp styles.css /opt/notes2web
|
cp styles.css /opt/notes2web
|
||||||
|
cp fuse.js /opt/notes2web
|
||||||
|
cp search.js /opt/notes2web
|
||||||
|
|
||||||
uninstall:
|
uninstall:
|
||||||
rm -rf /usr/local/bin/notes2web.py /opt/notes2web
|
rm -rf /usr/local/bin/notes2web.py /opt/notes2web
|
||||||
|
242
notes2web.py
242
notes2web.py
@@ -2,6 +2,8 @@
|
|||||||
|
|
||||||
|
|
||||||
from bs4 import BeautifulSoup as bs
|
from bs4 import BeautifulSoup as bs
|
||||||
|
import subprocess
|
||||||
|
import frontmatter
|
||||||
import magic
|
import magic
|
||||||
import sys
|
import sys
|
||||||
import pathlib
|
import pathlib
|
||||||
@@ -9,6 +11,8 @@ import pypandoc
|
|||||||
import shutil
|
import shutil
|
||||||
import os
|
import os
|
||||||
import re
|
import re
|
||||||
|
import json
|
||||||
|
|
||||||
|
|
||||||
TEXT_ARTICLE_TEMPLATE_FOOT = None
|
TEXT_ARTICLE_TEMPLATE_FOOT = None
|
||||||
TEXT_ARTICLE_TEMPLATE_HEAD = None
|
TEXT_ARTICLE_TEMPLATE_HEAD = None
|
||||||
@@ -16,6 +20,7 @@ INDEX_TEMPLATE_FOOT = None
|
|||||||
INDEX_TEMPLATE_HEAD = None
|
INDEX_TEMPLATE_HEAD = None
|
||||||
EXTRA_INDEX_CONTENT = None
|
EXTRA_INDEX_CONTENT = None
|
||||||
|
|
||||||
|
|
||||||
def get_files(folder):
|
def get_files(folder):
|
||||||
markdown = []
|
markdown = []
|
||||||
plaintext = []
|
plaintext = []
|
||||||
@@ -23,8 +28,10 @@ def get_files(folder):
|
|||||||
|
|
||||||
for root, folders, files in os.walk(folder):
|
for root, folders, files in os.walk(folder):
|
||||||
for filename in files:
|
for filename in files:
|
||||||
|
if '/.git' in root:
|
||||||
|
continue
|
||||||
name = os.path.join(root, filename)
|
name = os.path.join(root, filename)
|
||||||
if os.path.splitext(name)[1] == '.md':
|
if pathlib.Path(name).suffix == '.md':
|
||||||
markdown.append(name)
|
markdown.append(name)
|
||||||
elif re.match(r'^text/', magic.from_file(name, mime=True)):
|
elif re.match(r'^text/', magic.from_file(name, mime=True)):
|
||||||
plaintext.append(name)
|
plaintext.append(name)
|
||||||
@@ -34,6 +41,47 @@ def get_files(folder):
|
|||||||
|
|
||||||
return markdown, plaintext, other
|
return markdown, plaintext, other
|
||||||
|
|
||||||
|
|
||||||
|
def git_filehistory(working_dir, filename):
|
||||||
|
print(f"{pathlib.Path(filename).relative_to(working_dir)=}")
|
||||||
|
git_response = subprocess.run(
|
||||||
|
[
|
||||||
|
'git',
|
||||||
|
f"--git-dir={working_dir.joinpath('.git')}",
|
||||||
|
"log",
|
||||||
|
"-p",
|
||||||
|
"--",
|
||||||
|
pathlib.Path(filename).relative_to(working_dir)
|
||||||
|
],
|
||||||
|
stdout=subprocess.PIPE
|
||||||
|
)
|
||||||
|
|
||||||
|
filehistory = [f"File history not available: git log returned code {git_response.returncode}."
|
||||||
|
"\nIf this is not a git repository, this is not a problem."]
|
||||||
|
|
||||||
|
if git_response.returncode == 0:
|
||||||
|
filehistory = git_response.stdout.decode('utf-8')
|
||||||
|
temp = re.split(
|
||||||
|
r'(commit [a-f0-9]{40})',
|
||||||
|
filehistory,
|
||||||
|
flags=re.IGNORECASE
|
||||||
|
)
|
||||||
|
|
||||||
|
for t in temp:
|
||||||
|
if t == '':
|
||||||
|
temp.remove(t)
|
||||||
|
filehistory = []
|
||||||
|
for i in range(0, len(temp)-1, 2):
|
||||||
|
filehistory.append(f"{temp[i]}{temp[i+1]}")
|
||||||
|
|
||||||
|
if filehistory == "":
|
||||||
|
filehistory = ["This file has no history (it may not be part of the git repository)."]
|
||||||
|
|
||||||
|
filehistory = "<pre>\n" + "</pre><pre>\n".join(filehistory) + "</pre>"
|
||||||
|
|
||||||
|
return filehistory
|
||||||
|
|
||||||
|
|
||||||
def get_dirs(folder):
|
def get_dirs(folder):
|
||||||
r = []
|
r = []
|
||||||
|
|
||||||
@@ -43,6 +91,10 @@ def get_dirs(folder):
|
|||||||
return r
|
return r
|
||||||
|
|
||||||
|
|
||||||
|
def update_required(src_filename, output_filename):
|
||||||
|
return not os.path.exists(output_filename) or os.path.getmtime(src_filename) > os.path.getmtime(output_filename)
|
||||||
|
|
||||||
|
|
||||||
def get_args():
|
def get_args():
|
||||||
""" Get command line arguments """
|
""" Get command line arguments """
|
||||||
|
|
||||||
@@ -56,7 +108,12 @@ def get_args():
|
|||||||
parser.add_argument('-i', '--template-index-head', type=pathlib.Path, default=pathlib.Path('/opt/notes2web/templates/indexhead.html'))
|
parser.add_argument('-i', '--template-index-head', type=pathlib.Path, default=pathlib.Path('/opt/notes2web/templates/indexhead.html'))
|
||||||
parser.add_argument('-I', '--template-index-foot', type=pathlib.Path, default=pathlib.Path('/opt/notes2web/templates/indexfoot.html'))
|
parser.add_argument('-I', '--template-index-foot', type=pathlib.Path, default=pathlib.Path('/opt/notes2web/templates/indexfoot.html'))
|
||||||
parser.add_argument('-s', '--stylesheet', type=pathlib.Path, default=pathlib.Path('/opt/notes2web/styles.css'))
|
parser.add_argument('-s', '--stylesheet', type=pathlib.Path, default=pathlib.Path('/opt/notes2web/styles.css'))
|
||||||
|
parser.add_argument('--home_index', type=pathlib.Path, default=pathlib.Path('/opt/notes2web/templates/home_index.html'))
|
||||||
parser.add_argument('-e', '--extra-index-content', type=pathlib.Path, default=pathlib.Path('/opt/notes2web/templates/extra_index_content.html'))
|
parser.add_argument('-e', '--extra-index-content', type=pathlib.Path, default=pathlib.Path('/opt/notes2web/templates/extra_index_content.html'))
|
||||||
|
parser.add_argument('-n', '--index-article-names', action='append', default=['index.md'])
|
||||||
|
parser.add_argument('-F', '--force', action="store_true", help="Generate new output html even if source file was modified before output html")
|
||||||
|
parser.add_argument('--fuse', type=pathlib.Path, default=pathlib.Path('/opt/notes2web/fuse.js'))
|
||||||
|
parser.add_argument('--searchjs', type=pathlib.Path, default=pathlib.Path('/opt/notes2web/search.js'))
|
||||||
return parser.parse_args()
|
return parser.parse_args()
|
||||||
|
|
||||||
|
|
||||||
@@ -78,98 +135,209 @@ def main(args):
|
|||||||
with open(args.extra_index_content) as fp:
|
with open(args.extra_index_content) as fp:
|
||||||
EXTRA_INDEX_CONTENT = fp.read()
|
EXTRA_INDEX_CONTENT = fp.read()
|
||||||
|
|
||||||
if not os.path.exists(args.output_dir):
|
if args.output_dir.is_file():
|
||||||
os.makedirs(args.output_dir, exist_ok=True)
|
print(f"Output directory ({args.output_dir}) cannot be a file.")
|
||||||
|
|
||||||
if os.path.isfile(args.output_dir):
|
|
||||||
print("Output directory ({output_dir}) cannot be a file.")
|
|
||||||
|
|
||||||
|
args.output_dir.mkdir(parents=True, exist_ok=True)
|
||||||
|
|
||||||
markdown_files, plaintext_files, other_files = get_files(args.notes)
|
markdown_files, plaintext_files, other_files = get_files(args.notes)
|
||||||
|
|
||||||
|
all_entries=[]
|
||||||
|
dirs_with_index_article = []
|
||||||
|
tag_dict = {}
|
||||||
|
|
||||||
print(f"{markdown_files=}")
|
print(f"{markdown_files=}")
|
||||||
for filename in markdown_files:
|
for filename in markdown_files:
|
||||||
print(f"{filename=}")
|
print(f"{filename=}")
|
||||||
html = pypandoc.convert_file(filename, 'html', extra_args=[f'--template={args.template}'])
|
|
||||||
output_filename = os.path.splitext(re.sub(f"^{args.notes.name}", args.output_dir.name, filename))[0] + '.html'
|
|
||||||
os.makedirs(os.path.dirname(output_filename), exist_ok=True)
|
|
||||||
|
|
||||||
with open(output_filename, 'w+') as fp:
|
# calculate output filename
|
||||||
fp.write(html)
|
output_filename = args.output_dir.joinpath('notes').joinpath(
|
||||||
|
pathlib.Path(filename).relative_to(args.notes)
|
||||||
|
).with_suffix('.html')
|
||||||
|
if os.path.basename(filename) in args.index_article_names:
|
||||||
|
output_filename = output_filename.parent.joinpath('index.html')
|
||||||
|
dirs_with_index_article.append(str(output_filename.parent))
|
||||||
|
print(f"{output_filename=}")
|
||||||
|
|
||||||
|
# extract tags from frontmatter, save to tag_dict
|
||||||
|
fm = frontmatter.load(filename)
|
||||||
|
if isinstance(fm.get('tags'), list):
|
||||||
|
for tag in fm.get('tags'):
|
||||||
|
t = {
|
||||||
|
'path': str(pathlib.Path(output_filename).relative_to(args.output_dir)),
|
||||||
|
'title': fm.get('title') or pathlib.Path(filename).name
|
||||||
|
}
|
||||||
|
if tag in tag_dict.keys():
|
||||||
|
tag_dict[tag].append(t)
|
||||||
|
else:
|
||||||
|
tag_dict[tag] = [t]
|
||||||
|
|
||||||
|
# find headers in markdown
|
||||||
|
with open(filename) as fp:
|
||||||
|
lines = fp.read().split('\n')
|
||||||
|
header_lines = []
|
||||||
|
for line in lines:
|
||||||
|
if re.match('^#{1,6} \S', line):
|
||||||
|
header_lines.append(" ".join(line.split(" ")[1:]))
|
||||||
|
|
||||||
|
all_entries.append({
|
||||||
|
'path': str(pathlib.Path(*pathlib.Path(output_filename).parts[1:])),
|
||||||
|
'title': fm.get('title') or pathlib.Path(filename).name,
|
||||||
|
'tags': fm.get('tags'),
|
||||||
|
'headers': header_lines
|
||||||
|
})
|
||||||
|
|
||||||
|
# update file if required
|
||||||
|
if update_required(filename, output_filename) or args.force:
|
||||||
|
filehistory = git_filehistory(args.notes, filename)
|
||||||
|
html = pypandoc.convert_file(filename, 'html', extra_args=[f'--template={args.template}', '-V', f'filehistory={filehistory}'])
|
||||||
|
pathlib.Path(output_filename).parent.mkdir(parents=True, exist_ok=True)
|
||||||
|
|
||||||
|
with open(output_filename, 'w+') as fp:
|
||||||
|
fp.write(html)
|
||||||
|
|
||||||
print(f"{plaintext_files=}")
|
print(f"{plaintext_files=}")
|
||||||
for filename in plaintext_files:
|
for filename in plaintext_files:
|
||||||
output_filename = re.sub(f"^{args.notes.name}", args.output_dir.name, filename) + '.html'
|
filehistory = git_filehistory(args.notes, filename)
|
||||||
os.makedirs(os.path.dirname(output_filename), exist_ok=True)
|
title = os.path.basename(filename)
|
||||||
title = os.path.basename(output_filename)
|
output_filename = str(
|
||||||
|
args.output_dir.joinpath('notes').joinpath(
|
||||||
|
pathlib.Path(filename).relative_to(args.notes)
|
||||||
|
)
|
||||||
|
) + '.html'
|
||||||
|
print(f"{output_filename=}")
|
||||||
|
|
||||||
|
pathlib.Path(output_filename).parent.mkdir(parents=True, exist_ok=True)
|
||||||
html = re.sub(r'\$title\$', title, TEXT_ARTICLE_TEMPLATE_HEAD)
|
html = re.sub(r'\$title\$', title, TEXT_ARTICLE_TEMPLATE_HEAD)
|
||||||
|
html = re.sub(r'\$h1title\$', title, html)
|
||||||
html = re.sub(r'\$raw\$', os.path.basename(filename), html)
|
html = re.sub(r'\$raw\$', os.path.basename(filename), html)
|
||||||
|
html = html.replace('$filehistory$', filehistory)
|
||||||
with open(filename) as fp:
|
with open(filename) as fp:
|
||||||
html += fp.read()
|
html += fp.read().replace("<", "<").replace(">", ">")
|
||||||
html += TEXT_ARTICLE_TEMPLATE_FOOT
|
html += TEXT_ARTICLE_TEMPLATE_FOOT
|
||||||
|
|
||||||
with open(output_filename, 'w+') as fp:
|
with open(output_filename, 'w+') as fp:
|
||||||
fp.write(html)
|
fp.write(html)
|
||||||
|
all_entries.append({
|
||||||
|
'path': str(pathlib.Path(*pathlib.Path(output_filename).parts[1:])),
|
||||||
|
'title': title,
|
||||||
|
'tags': [],
|
||||||
|
'headers': []
|
||||||
|
})
|
||||||
|
|
||||||
print(f"{other_files=}")
|
print(f"{other_files=}")
|
||||||
for filename in other_files:
|
for filename in other_files:
|
||||||
output_filename = re.sub(f"^{args.notes.name}", args.output_dir.name, filename)
|
output_filename = str(
|
||||||
os.makedirs(os.path.dirname(output_filename), exist_ok=True)
|
args.output_dir.joinpath('notes').joinpath(
|
||||||
|
pathlib.Path(filename).relative_to(args.notes)
|
||||||
|
)
|
||||||
|
)
|
||||||
|
pathlib.Path(output_filename).parent.mkdir(parents=True, exist_ok=True)
|
||||||
|
all_entries.append({
|
||||||
|
'path': str(pathlib.Path(*pathlib.Path(output_filename).parts[1:])),
|
||||||
|
'title': str(pathlib.Path(*pathlib.Path(output_filename).parts[1:])),
|
||||||
|
'tags': [],
|
||||||
|
'headers': []
|
||||||
|
})
|
||||||
shutil.copyfile(filename, output_filename)
|
shutil.copyfile(filename, output_filename)
|
||||||
|
|
||||||
|
tagdir = args.output_dir.joinpath('.tags')
|
||||||
|
tagdir.mkdir(parents=True, exist_ok=True)
|
||||||
|
|
||||||
|
for tag in tag_dict.keys():
|
||||||
|
html = re.sub(r'\$title\$', f'{tag}', INDEX_TEMPLATE_HEAD)
|
||||||
|
html = re.sub(r'\$h1title\$', f'tag: {tag}', html)
|
||||||
|
html = re.sub(r'\$extra_content\$', '', html)
|
||||||
|
|
||||||
|
for entry in tag_dict[tag]:
|
||||||
|
html += f"<div class=\"article\"><a href=\"/{entry['path']}\">{entry['title']}</a></div>"
|
||||||
|
html += INDEX_TEMPLATE_FOOT
|
||||||
|
|
||||||
|
with open(tagdir.joinpath(f'{tag}.html'), 'w+') as fp:
|
||||||
|
fp.write(html)
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
dirs_to_index = [args.output_dir.name] + get_dirs(args.output_dir)
|
dirs_to_index = [args.output_dir.name] + get_dirs(args.output_dir)
|
||||||
print(f"{dirs_to_index=}")
|
print(f"{dirs_to_index=}")
|
||||||
print(f"{os.path.commonpath(dirs_to_index)=}")
|
print(f"{dirs_with_index_article=}")
|
||||||
|
|
||||||
for directory in dirs_to_index:
|
for d in dirs_to_index:
|
||||||
|
print(f"{d in dirs_with_index_article=} {d=}")
|
||||||
|
if d in dirs_with_index_article:
|
||||||
|
continue
|
||||||
|
|
||||||
|
directory = pathlib.Path(d)
|
||||||
paths = os.listdir(directory)
|
paths = os.listdir(directory)
|
||||||
print(f"{paths=}")
|
#print(f"{paths=}")
|
||||||
|
|
||||||
indexentries = []
|
indexentries = []
|
||||||
|
|
||||||
for path in paths:
|
for p in paths:
|
||||||
if path == 'index.html':
|
path = pathlib.Path(p)
|
||||||
|
#print(f"{path=}")
|
||||||
|
if p in [ 'index.html', '.git' ]:
|
||||||
continue
|
continue
|
||||||
|
|
||||||
fullpath = os.path.join(directory, path)
|
fullpath = directory.joinpath(path)
|
||||||
if os.path.splitext(path)[1] == '.html':
|
if path.suffix == '.html':
|
||||||
with open(fullpath) as fp:
|
with open(fullpath) as fp:
|
||||||
soup = bs(fp.read(), 'html.parser')
|
soup = bs(fp.read(), 'html.parser')
|
||||||
|
|
||||||
try:
|
try:
|
||||||
title = soup.find('title').get_text()
|
title = soup.find('title').get_text() or pathlib.Path(path).name
|
||||||
except AttributeError:
|
except AttributeError:
|
||||||
title = path
|
title = pathlib.Path(path).stem
|
||||||
else:
|
elif fullpath.is_dir():
|
||||||
title = path
|
title = path
|
||||||
|
else:
|
||||||
|
# don't add plaintext files to index, since they have a html wrapper
|
||||||
|
continue
|
||||||
|
|
||||||
if title.strip() == '':
|
if str(title).strip() == '':
|
||||||
title = path
|
title = path
|
||||||
|
|
||||||
indexentries.append({
|
indexentries.append({
|
||||||
'title': title,
|
'title': str(title),
|
||||||
'path': path,
|
'path': str(path),
|
||||||
'isdirectory': os.path.isdir(fullpath)
|
'isdirectory': fullpath.is_dir()
|
||||||
})
|
})
|
||||||
|
|
||||||
indexentries.sort(key=lambda entry: entry['title'])
|
indexentries.sort(key=lambda entry: str(entry['title']).lower())
|
||||||
indexentries.sort(key=lambda entry: entry['isdirectory'], reverse=True)
|
indexentries.sort(key=lambda entry: entry['isdirectory'], reverse=True)
|
||||||
|
|
||||||
html = re.sub(r'\$title\$', directory, INDEX_TEMPLATE_HEAD)
|
html = re.sub(r'\$title\$', str(directory), INDEX_TEMPLATE_HEAD)
|
||||||
|
html = re.sub(r'\$h1title\$', str(directory), html)
|
||||||
html = re.sub(r'\$extra_content\$',
|
html = re.sub(r'\$extra_content\$',
|
||||||
EXTRA_INDEX_CONTENT if directory == os.path.commonpath(dirs_to_index) else '',
|
EXTRA_INDEX_CONTENT if directory == args.notes else '',
|
||||||
html
|
html
|
||||||
)
|
)
|
||||||
|
|
||||||
for entry in indexentries:
|
for entry in indexentries:
|
||||||
html += f"<div class=\"article\"><a href=\"{entry['path']}\">{entry['title']}{'/' if entry['isdirectory'] else ''}</a></div>"
|
html += (
|
||||||
|
'<div class="article">'
|
||||||
|
f'<a href="{entry["path"]}">'
|
||||||
|
f'{entry["title"]}{"/" if entry["isdirectory"] else ""}'
|
||||||
|
'</a>'
|
||||||
|
'</div>'
|
||||||
|
)
|
||||||
html += INDEX_TEMPLATE_FOOT
|
html += INDEX_TEMPLATE_FOOT
|
||||||
|
|
||||||
with open(os.path.join(directory, 'index.html'), 'w+') as fp:
|
with open(directory.joinpath('index.html'), 'w+') as fp:
|
||||||
fp.write(html)
|
fp.write(html)
|
||||||
|
|
||||||
shutil.copyfile(args.stylesheet, os.path.join(args.output_dir.name, 'styles.css'))
|
shutil.copyfile(args.stylesheet, args.output_dir.joinpath('styles.css'))
|
||||||
|
shutil.copyfile(args.fuse, args.output_dir.joinpath('fuse.js'))
|
||||||
|
shutil.copyfile(args.searchjs, args.output_dir.joinpath('search.js'))
|
||||||
|
with open(args.output_dir.joinpath('index.html'), 'w+') as fp:
|
||||||
|
with open(args.home_index) as fp2:
|
||||||
|
html = re.sub(r'\$title\$', args.output_dir.parts[0], fp2.read())
|
||||||
|
html = re.sub(r'\$h1title\$', args.output_dir.parts[0], html)
|
||||||
|
|
||||||
|
html = re.sub(r'\$data\$', json.dumps(all_entries), html)
|
||||||
|
|
||||||
|
fp.write(html)
|
||||||
|
print(tag_dict)
|
||||||
|
|
||||||
return 0
|
return 0
|
||||||
|
|
||||||
|
47
readme.md
47
readme.md
@@ -1,24 +1,51 @@
|
|||||||
# notes2web
|
# notes2web
|
||||||
|
|
||||||
View your notes as a static html site.
|
View your notes as a static html site. Browse a live sample of it [here](https://notes.alv.cx).
|
||||||
|
|
||||||

|

|
||||||
|
|
||||||
|
|
||||||
|
## Why?
|
||||||
|
|
||||||
|
I want to be able to view my notes in a more convenient way.
|
||||||
|
I was already writing them in Pandoc markdown and could view them as PDFs but that wasn't quite
|
||||||
|
doing it for me:
|
||||||
|
|
||||||
|
- It was inconvenient to flick through multiple files of notes to find the right PDF
|
||||||
|
- It was annoying to sync to my phone
|
||||||
|
- PDFs do not scale so they were hard to read on smaller screens
|
||||||
|
- Probably more reasons I can't think of right now
|
||||||
|
- Fun
|
||||||
|
|
||||||
|
|
||||||
## Install
|
## Install
|
||||||
|
|
||||||
0. Install [Pandoc](https://pandoc.org/index.html) and [yq](https://github.com/mikefarah/yq)
|
0. Install [Pandoc](https://pandoc.org/index.html) and [Pip](https://github.com/pypa/pip)
|
||||||
|
|
||||||
On arch:
|
On arch:
|
||||||
```
|
```
|
||||||
# pacman -S pandoc yq
|
# pacman -S pandoc python-pip
|
||||||
```
|
```
|
||||||
|
|
||||||
1. Run `make install` as root
|
1. Run `make install` as root
|
||||||
|
|
||||||
## Usage
|
## Things to Remember Whilst Writing Notes
|
||||||
|
|
||||||
|
- notes2web reads the following YAML [frontmatter](https://jekyllrb.com/docs/front-matter/) variable:
|
||||||
|
|
||||||
|
- `author` --- The person(s) who wrote the article
|
||||||
|
- `tags` --- A YAML list of tags which the article relates to - this is used for browsing and also
|
||||||
|
searching
|
||||||
|
- `title` --- The title of the article
|
||||||
|
|
||||||
|
- notes2web indexes [ATX-style headings](https://pandoc.org/MANUAL.html#atx-style-headings) for
|
||||||
|
searching
|
||||||
|
- notes2web attempts to display file history through the `git log` command
|
||||||
|
|
||||||
|
## CLI Usage
|
||||||
|
|
||||||
```
|
```
|
||||||
$ notes2web.py NOTES_DIRECTORY_1
|
$ notes2web.py notes_directory
|
||||||
```
|
```
|
||||||
|
|
||||||
Output of `notes2web.py --help`:
|
Output of `notes2web.py --help`:
|
||||||
@@ -27,7 +54,9 @@ Output of `notes2web.py --help`:
|
|||||||
usage: notes2web.py [-h] [-o OUTPUT_DIR] [-t TEMPLATE] [-H TEMPLATE_TEXT_HEAD]
|
usage: notes2web.py [-h] [-o OUTPUT_DIR] [-t TEMPLATE] [-H TEMPLATE_TEXT_HEAD]
|
||||||
[-f TEMPLATE_TEXT_FOOT] [-i TEMPLATE_INDEX_HEAD]
|
[-f TEMPLATE_TEXT_FOOT] [-i TEMPLATE_INDEX_HEAD]
|
||||||
[-I TEMPLATE_INDEX_FOOT] [-s STYLESHEET]
|
[-I TEMPLATE_INDEX_FOOT] [-s STYLESHEET]
|
||||||
[-e EXTRA_INDEX_CONTENT]
|
[--home_index HOME_INDEX] [-e EXTRA_INDEX_CONTENT]
|
||||||
|
[-n INDEX_ARTICLE_NAMES] [-F] [--fuse FUSE]
|
||||||
|
[--searchjs SEARCHJS]
|
||||||
notes
|
notes
|
||||||
|
|
||||||
positional arguments:
|
positional arguments:
|
||||||
@@ -42,7 +71,13 @@ optional arguments:
|
|||||||
-i TEMPLATE_INDEX_HEAD, --template-index-head TEMPLATE_INDEX_HEAD
|
-i TEMPLATE_INDEX_HEAD, --template-index-head TEMPLATE_INDEX_HEAD
|
||||||
-I TEMPLATE_INDEX_FOOT, --template-index-foot TEMPLATE_INDEX_FOOT
|
-I TEMPLATE_INDEX_FOOT, --template-index-foot TEMPLATE_INDEX_FOOT
|
||||||
-s STYLESHEET, --stylesheet STYLESHEET
|
-s STYLESHEET, --stylesheet STYLESHEET
|
||||||
|
--home_index HOME_INDEX
|
||||||
-e EXTRA_INDEX_CONTENT, --extra-index-content EXTRA_INDEX_CONTENT
|
-e EXTRA_INDEX_CONTENT, --extra-index-content EXTRA_INDEX_CONTENT
|
||||||
|
-n INDEX_ARTICLE_NAMES, --index-article-names INDEX_ARTICLE_NAMES
|
||||||
|
-F, --force Generate new output html even if source file was
|
||||||
|
modified before output html
|
||||||
|
--fuse FUSE
|
||||||
|
--searchjs SEARCHJS
|
||||||
```
|
```
|
||||||
|
|
||||||
The command will generate a website in the `output-dir` directory (`./web` by default).
|
The command will generate a website in the `output-dir` directory (`./web` by default).
|
||||||
|
@@ -1,3 +1,6 @@
|
|||||||
beautifulsoup4==4.9.3
|
beautifulsoup4==4.9.3
|
||||||
pypandoc==1.5
|
pypandoc==1.5
|
||||||
|
python-frontmatter==1.0.0
|
||||||
|
python-magic==0.4.24
|
||||||
|
PyYAML==5.4.1
|
||||||
soupsieve==2.2.1
|
soupsieve==2.2.1
|
||||||
|
BIN
screenshot.png
BIN
screenshot.png
Binary file not shown.
Before Width: | Height: | Size: 198 KiB After Width: | Height: | Size: 163 KiB |
86
search.js
Normal file
86
search.js
Normal file
@@ -0,0 +1,86 @@
|
|||||||
|
const HEADERS = "headers"
|
||||||
|
const PATH = "path"
|
||||||
|
const TAGS = "tags"
|
||||||
|
const TITLE = "title"
|
||||||
|
|
||||||
|
const fuse = new Fuse(data, {
|
||||||
|
keys: [ HEADERS, PATH, TAGS, TITLE ],
|
||||||
|
includeMatches: true
|
||||||
|
})
|
||||||
|
|
||||||
|
const searchBar = document.getElementById('search')
|
||||||
|
const resultsMax = document.getElementById('resultsMax')
|
||||||
|
const resultsDiv = document.getElementById('results')
|
||||||
|
|
||||||
|
var results = []
|
||||||
|
|
||||||
|
function updateResults() {
|
||||||
|
resultsDiv.innerHTML = ''
|
||||||
|
results = fuse.search(searchBar.value).slice(0, parseInt(resultsMax.value))
|
||||||
|
results.forEach(r => {
|
||||||
|
wrapper = document.createElement('div')
|
||||||
|
wrapper.className = "article"
|
||||||
|
|
||||||
|
display_matches = {}
|
||||||
|
display_matches[HEADERS] = []
|
||||||
|
display_matches[PATH] = []
|
||||||
|
display_matches[TAGS] = []
|
||||||
|
display_matches[TITLE] = []
|
||||||
|
|
||||||
|
r.matches.every(match => {
|
||||||
|
if (display_matches[match.key].length > 3) {
|
||||||
|
display_matches[match.key].push('...')
|
||||||
|
return false
|
||||||
|
}
|
||||||
|
|
||||||
|
display_match = match.value
|
||||||
|
if (match.indices.length >= 1) {
|
||||||
|
match.indices.sort((a, b) => (b[1]-b[0])-(a[1]-a[0]))
|
||||||
|
indexPair = match.indices[0]
|
||||||
|
matching_slice = match.value.slice(indexPair[0], indexPair[1]+1)
|
||||||
|
display_match = match.value.replace(
|
||||||
|
matching_slice,
|
||||||
|
'<span class="matchHighlight">' + matching_slice + '</span>'
|
||||||
|
)
|
||||||
|
}
|
||||||
|
display_matches[match.key].push(display_match)
|
||||||
|
|
||||||
|
return true
|
||||||
|
})
|
||||||
|
|
||||||
|
content = document.createElement('a')
|
||||||
|
content.innerHTML = r.item.title
|
||||||
|
content.href = r.item.path
|
||||||
|
|
||||||
|
wrapper.appendChild(content)
|
||||||
|
|
||||||
|
Object.keys(display_matches).forEach(key => {
|
||||||
|
if (display_matches[key].length < 1) return
|
||||||
|
|
||||||
|
p = document.createElement('p')
|
||||||
|
p.className = "smallText"
|
||||||
|
p.innerHTML += key + ": [" + display_matches[key].join(', ') + ']'
|
||||||
|
wrapper.appendChild(p)
|
||||||
|
})
|
||||||
|
|
||||||
|
resultsDiv.appendChild(wrapper)
|
||||||
|
})
|
||||||
|
}
|
||||||
|
|
||||||
|
searchBar.addEventListener('keyup', e => {
|
||||||
|
console.log(e)
|
||||||
|
// if user pressed enter
|
||||||
|
if (e.keyCode === 13) {
|
||||||
|
if (e.shiftKey) {
|
||||||
|
window.open(results[0].item.path, '_blank')
|
||||||
|
} else {
|
||||||
|
window.location.href = results[0].item.path
|
||||||
|
}
|
||||||
|
return
|
||||||
|
}
|
||||||
|
updateResults()
|
||||||
|
})
|
||||||
|
searchBar.addEventListener('change', updateResults)
|
||||||
|
resultsMax.addEventListener('keyup', updateResults)
|
||||||
|
resultsMax.addEventListener('change', updateResults)
|
||||||
|
updateResults()
|
44
styles.css
44
styles.css
@@ -35,6 +35,7 @@ pre {
|
|||||||
background-color: #d9d9d9 ;
|
background-color: #d9d9d9 ;
|
||||||
color: #000;
|
color: #000;
|
||||||
padding: 1em;
|
padding: 1em;
|
||||||
|
overflow-x: scroll;
|
||||||
}
|
}
|
||||||
|
|
||||||
details {
|
details {
|
||||||
@@ -71,3 +72,46 @@ blockquote {
|
|||||||
blockquote * {
|
blockquote * {
|
||||||
margin: 0;
|
margin: 0;
|
||||||
}
|
}
|
||||||
|
|
||||||
|
#searchWrapper > input {
|
||||||
|
padding: 1em;
|
||||||
|
margin: 1em 0.5em 1em 0.5em;
|
||||||
|
font-size: 1em;
|
||||||
|
min-width: 0;
|
||||||
|
}
|
||||||
|
|
||||||
|
#searchWrapper {
|
||||||
|
display: flex
|
||||||
|
}
|
||||||
|
|
||||||
|
#search { flex-grow: 9 }
|
||||||
|
|
||||||
|
#results {
|
||||||
|
overflow-x: scroll;
|
||||||
|
}
|
||||||
|
|
||||||
|
.smallText {
|
||||||
|
font-size: 0.7em;
|
||||||
|
}
|
||||||
|
|
||||||
|
.article .smallText {
|
||||||
|
margin: 0
|
||||||
|
}
|
||||||
|
|
||||||
|
.matchHighlight {
|
||||||
|
background-color: #86c1b9;
|
||||||
|
}
|
||||||
|
|
||||||
|
#header > * {
|
||||||
|
margin: 0;
|
||||||
|
padding: 0
|
||||||
|
}
|
||||||
|
|
||||||
|
kbd {
|
||||||
|
background-color: #d9d9d9;
|
||||||
|
border-radius: 0.25em;
|
||||||
|
padding: 0.2em;
|
||||||
|
box-shadow: 0.15em 0.15em 0 #c9c9c9;
|
||||||
|
margin-left: 0.2em;
|
||||||
|
margin-right: 0.2em;
|
||||||
|
}
|
||||||
|
@@ -9,6 +9,19 @@
|
|||||||
</head>
|
</head>
|
||||||
|
|
||||||
<body>
|
<body>
|
||||||
|
<div id="header">
|
||||||
|
<p style="font-size: 0.7em"> tags:
|
||||||
|
$for(tags)$
|
||||||
|
<a href="/.tags/$tags$.html">$tags$</a>$sep$,
|
||||||
|
$endfor$
|
||||||
|
</p>
|
||||||
|
<p class="smallText" id="footer"> written by $author$, generated by <a href="https://git.alv.cx/alvierahman90/notes2web">notes2web</a></p>
|
||||||
|
<details id="commitLog">
|
||||||
|
<summary class="smallText">
|
||||||
|
Commit log (file history)
|
||||||
|
</summary>
|
||||||
|
$filehistory$
|
||||||
|
</details>
|
||||||
|
<div>
|
||||||
$body$
|
$body$
|
||||||
<p style="font-size: 0.7em;"> page generated by <a href="https://github.com/alvierahman90/notes2web">notes2web</a></p>
|
|
||||||
</body>
|
</body>
|
||||||
|
@@ -1 +1,4 @@
|
|||||||
<p>These are my personal notes. Correctness is not guaranteed.</p>
|
<p>
|
||||||
|
These are my personal notes. Correctness is not guaranteed.
|
||||||
|
Browse by tag <a href="/.tags">here</a>.
|
||||||
|
</p>
|
||||||
|
28
templates/home_index.html
Normal file
28
templates/home_index.html
Normal file
@@ -0,0 +1,28 @@
|
|||||||
|
<head>
|
||||||
|
<meta name="viewport" content="width=device-width, initial-scale=1">
|
||||||
|
<meta charset="utf-8">
|
||||||
|
<link rel="stylesheet" href="https://fonts.googleapis.com/css2?family=Open+Sans&display=swap" />
|
||||||
|
<link rel="stylesheet" type="text/css" href="/styles.css" />
|
||||||
|
<title>$title$</title>
|
||||||
|
</head>
|
||||||
|
<body>
|
||||||
|
<h1>$h1title$</h1>
|
||||||
|
<p>
|
||||||
|
These are my personal notes. Correctness is not guaranteed.
|
||||||
|
Browse <a href="/notes">here</a> or by tag <a href="/.tags">here</a>.
|
||||||
|
</p>
|
||||||
|
|
||||||
|
<div id="searchWrapper">
|
||||||
|
<input placeholder="Search" id="search">
|
||||||
|
<input type="number" id="resultsMax" min="0" value="5">
|
||||||
|
</div>
|
||||||
|
<p class="smallText" style="margin-top: 0; text-align: center;"> Press <kbd>Enter</kbd> to open first result or <kbd>Shift</kbd>+<kbd>Enter</kbd> to open in new tab</p>
|
||||||
|
<div id="results">
|
||||||
|
</div>
|
||||||
|
|
||||||
|
<p class="smallText"> page generated by <a href="https://github.com/alvierahman90/notes2web">notes2web</a></p>
|
||||||
|
|
||||||
|
<script src="/fuse.js"> </script>
|
||||||
|
<script> const data = $data$ </script>
|
||||||
|
<script src="/search.js"> </script>
|
||||||
|
</body>
|
@@ -6,7 +6,7 @@
|
|||||||
<title>$title$</title>
|
<title>$title$</title>
|
||||||
</head>
|
</head>
|
||||||
<body>
|
<body>
|
||||||
<h1>$title$</h1>
|
<h1>$h1title$</h1>
|
||||||
$body$
|
$body$
|
||||||
|
|
||||||
<p style="font-size: 0.7em;"> page generated by <a href="https://github.com/alvierahman90/notes2web">notes2web</a></p>
|
<p style="font-size: 0.7em;"> page generated by <a href="https://github.com/alvierahman90/notes2web">notes2web</a></p>
|
||||||
|
@@ -1,3 +1,2 @@
|
|||||||
</pre>
|
</pre>
|
||||||
<p style="font-size: 0.7em;"> page generated by <a href="https://github.com/alvierahman90/notes2web">notes2web</a></p>
|
|
||||||
</body>
|
</body>
|
||||||
|
@@ -7,6 +7,15 @@
|
|||||||
</head>
|
</head>
|
||||||
|
|
||||||
<body>
|
<body>
|
||||||
|
<div id="header">
|
||||||
|
<p class="smallText" id="footer"> page generated by <a href="https://git.alv.cx/alvierahman90/notes2web">notes2web</a></p>
|
||||||
|
<details>
|
||||||
|
<summary class="smallText">
|
||||||
|
Commit log (file history)
|
||||||
|
</summary>
|
||||||
|
$filehistory$
|
||||||
|
</details>
|
||||||
|
</div>
|
||||||
<h1>$title$</h1>
|
<h1>$title$</h1>
|
||||||
<p> This file was not rendered by notes2web because it is a plaintext file, not a markdown
|
<p> This file was not rendered by notes2web because it is a plaintext file, not a markdown
|
||||||
file.
|
file.
|
||||||
|
Reference in New Issue
Block a user