Compare commits
127 Commits
Author | SHA1 | Date | |
---|---|---|---|
0dd69c3fe3
|
|||
95003803eb
|
|||
fddbbf4c50
|
|||
8b4765e9fb
|
|||
d83611f12a
|
|||
1eca81cd1d
|
|||
91a57aa8c9
|
|||
3a9cc4c0f8
|
|||
44bea9c982
|
|||
5c8e1e5253
|
|||
451bc567e2
|
|||
80dce5d4ed
|
|||
48f64bf3d4
|
|||
4e5bd41953
|
|||
de3d758005
|
|||
444c777135
|
|||
9c6b2247a7
|
|||
09334831f7
|
|||
af5bef0125
|
|||
b4aa431f4d
|
|||
49a215a587
|
|||
0a0bd542fc
|
|||
36f40f3269
|
|||
b61f1ba3b2
|
|||
bef8aeda52
|
|||
5bb40a57d1
|
|||
29529cfd6a
|
|||
8bd9173847
|
|||
dc4560c232
|
|||
da0d9db113
|
|||
98a6649a39
|
|||
0ae70aa2b3
|
|||
a91f5dcdfc
|
|||
df8febd3cf
|
|||
32a32b873e
|
|||
82e5c3e254
|
|||
c8e8ecd76c
|
|||
45e9e9a95e
|
|||
48268770b7
|
|||
79f5acd020
|
|||
a10bca718b
|
|||
18ea2a3b04
|
|||
8cc14c8a3e
|
|||
a17b475a4b
|
|||
03fff83930
|
|||
2a35e967f0
|
|||
8ba82c2911
|
|||
b050b36747
|
|||
8e09404520
|
|||
1c4dad1b2e
|
|||
9ccf00e78a
|
|||
59eccec7c4
|
|||
adc2a36fc2
|
|||
3368bdb999
|
|||
8f5d1a1a3b
|
|||
b6e69f5596
|
|||
bbb49d7a34
|
|||
9e58be3a01
|
|||
496216568e
|
|||
2b8874106f
|
|||
b35e868850
|
|||
485022a1a6
|
|||
dbe652f531
|
|||
334cf824c7
|
|||
20885c5d03
|
|||
04609095d8
|
|||
15411335e9
|
|||
f301e83163
|
|||
98310897d4
|
|||
9323aeab53
|
|||
5c5f6ab89d
|
|||
ab618e77c1
|
|||
2f4ba8bba2
|
|||
117f1ee6ee
|
|||
a5341e770c
|
|||
b9404c206c
|
|||
6d10130155
|
|||
c5e2140738
|
|||
e331e4ce97
|
|||
e0471c8508
|
|||
0d2889252c
|
|||
c2b21e340e
|
|||
dbe7286936
|
|||
a647a6ab19
|
|||
23f81a28d8
|
|||
d147e56080
|
|||
ae43e1e54d
|
|||
|
f5b75ce74a | ||
8531509fae
|
|||
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 |
4
.dockerignore
Normal file
4
.dockerignore
Normal file
@@ -0,0 +1,4 @@
|
|||||||
|
.git
|
||||||
|
.env
|
||||||
|
env
|
||||||
|
**/__pycache__
|
5
.gitignore
vendored
5
.gitignore
vendored
@@ -1,2 +1,7 @@
|
|||||||
*.swp
|
*.swp
|
||||||
|
.env
|
||||||
env
|
env
|
||||||
|
n
|
||||||
|
web
|
||||||
|
planning.txt
|
||||||
|
**/__pycache__
|
||||||
|
31
Dockerfile
Normal file
31
Dockerfile
Normal file
@@ -0,0 +1,31 @@
|
|||||||
|
FROM python:3.12-bookworm
|
||||||
|
|
||||||
|
ARG ARCH=
|
||||||
|
|
||||||
|
ENV BUILDARCH=${ARCH}
|
||||||
|
ENV GRONK_CSS_DIR=./css
|
||||||
|
ENV GRONK_JS_DIR=./js
|
||||||
|
ENV GRONK_TEMPLATES_DIR=./templates
|
||||||
|
|
||||||
|
WORKDIR /usr/src/app
|
||||||
|
|
||||||
|
RUN mkdir /notes
|
||||||
|
RUN mkdir /web
|
||||||
|
|
||||||
|
VOLUME /usr/src/app/notes
|
||||||
|
VOLUME /usr/src/app/web
|
||||||
|
|
||||||
|
RUN apt-get update \
|
||||||
|
&& wget -O ./pandoc.deb https://github.com/jgm/pandoc/releases/download/3.1.11/pandoc-3.1.11-1-${BUILDARCH}.deb \
|
||||||
|
&& apt install -y -f ./pandoc.deb \
|
||||||
|
&& rm ./pandoc.deb
|
||||||
|
|
||||||
|
COPY requirements.txt ./
|
||||||
|
RUN pip install --no-cache-dir -r requirements.txt
|
||||||
|
|
||||||
|
RUN useradd -Ms /bin/nologin user
|
||||||
|
USER user
|
||||||
|
|
||||||
|
COPY . .
|
||||||
|
|
||||||
|
CMD [ "python3", "-u", "gronk.py", "--output-dir", "./web", "./notes" ]
|
674
LICENSE
Normal file
674
LICENSE
Normal file
@@ -0,0 +1,674 @@
|
|||||||
|
GNU GENERAL PUBLIC LICENSE
|
||||||
|
Version 3, 29 June 2007
|
||||||
|
|
||||||
|
Copyright (C) 2007 Free Software Foundation, Inc. <https://fsf.org/>
|
||||||
|
Everyone is permitted to copy and distribute verbatim copies
|
||||||
|
of this license document, but changing it is not allowed.
|
||||||
|
|
||||||
|
Preamble
|
||||||
|
|
||||||
|
The GNU General Public License is a free, copyleft license for
|
||||||
|
software and other kinds of works.
|
||||||
|
|
||||||
|
The licenses for most software and other practical works are designed
|
||||||
|
to take away your freedom to share and change the works. By contrast,
|
||||||
|
the GNU General Public License is intended to guarantee your freedom to
|
||||||
|
share and change all versions of a program--to make sure it remains free
|
||||||
|
software for all its users. We, the Free Software Foundation, use the
|
||||||
|
GNU General Public License for most of our software; it applies also to
|
||||||
|
any other work released this way by its authors. You can apply it to
|
||||||
|
your programs, too.
|
||||||
|
|
||||||
|
When we speak of free software, we are referring to freedom, not
|
||||||
|
price. Our General Public Licenses are designed to make sure that you
|
||||||
|
have the freedom to distribute copies of free software (and charge for
|
||||||
|
them if you wish), that you receive source code or can get it if you
|
||||||
|
want it, that you can change the software or use pieces of it in new
|
||||||
|
free programs, and that you know you can do these things.
|
||||||
|
|
||||||
|
To protect your rights, we need to prevent others from denying you
|
||||||
|
these rights or asking you to surrender the rights. Therefore, you have
|
||||||
|
certain responsibilities if you distribute copies of the software, or if
|
||||||
|
you modify it: responsibilities to respect the freedom of others.
|
||||||
|
|
||||||
|
For example, if you distribute copies of such a program, whether
|
||||||
|
gratis or for a fee, you must pass on to the recipients the same
|
||||||
|
freedoms that you received. You must make sure that they, too, receive
|
||||||
|
or can get the source code. And you must show them these terms so they
|
||||||
|
know their rights.
|
||||||
|
|
||||||
|
Developers that use the GNU GPL protect your rights with two steps:
|
||||||
|
(1) assert copyright on the software, and (2) offer you this License
|
||||||
|
giving you legal permission to copy, distribute and/or modify it.
|
||||||
|
|
||||||
|
For the developers' and authors' protection, the GPL clearly explains
|
||||||
|
that there is no warranty for this free software. For both users' and
|
||||||
|
authors' sake, the GPL requires that modified versions be marked as
|
||||||
|
changed, so that their problems will not be attributed erroneously to
|
||||||
|
authors of previous versions.
|
||||||
|
|
||||||
|
Some devices are designed to deny users access to install or run
|
||||||
|
modified versions of the software inside them, although the manufacturer
|
||||||
|
can do so. This is fundamentally incompatible with the aim of
|
||||||
|
protecting users' freedom to change the software. The systematic
|
||||||
|
pattern of such abuse occurs in the area of products for individuals to
|
||||||
|
use, which is precisely where it is most unacceptable. Therefore, we
|
||||||
|
have designed this version of the GPL to prohibit the practice for those
|
||||||
|
products. If such problems arise substantially in other domains, we
|
||||||
|
stand ready to extend this provision to those domains in future versions
|
||||||
|
of the GPL, as needed to protect the freedom of users.
|
||||||
|
|
||||||
|
Finally, every program is threatened constantly by software patents.
|
||||||
|
States should not allow patents to restrict development and use of
|
||||||
|
software on general-purpose computers, but in those that do, we wish to
|
||||||
|
avoid the special danger that patents applied to a free program could
|
||||||
|
make it effectively proprietary. To prevent this, the GPL assures that
|
||||||
|
patents cannot be used to render the program non-free.
|
||||||
|
|
||||||
|
The precise terms and conditions for copying, distribution and
|
||||||
|
modification follow.
|
||||||
|
|
||||||
|
TERMS AND CONDITIONS
|
||||||
|
|
||||||
|
0. Definitions.
|
||||||
|
|
||||||
|
"This License" refers to version 3 of the GNU General Public License.
|
||||||
|
|
||||||
|
"Copyright" also means copyright-like laws that apply to other kinds of
|
||||||
|
works, such as semiconductor masks.
|
||||||
|
|
||||||
|
"The Program" refers to any copyrightable work licensed under this
|
||||||
|
License. Each licensee is addressed as "you". "Licensees" and
|
||||||
|
"recipients" may be individuals or organizations.
|
||||||
|
|
||||||
|
To "modify" a work means to copy from or adapt all or part of the work
|
||||||
|
in a fashion requiring copyright permission, other than the making of an
|
||||||
|
exact copy. The resulting work is called a "modified version" of the
|
||||||
|
earlier work or a work "based on" the earlier work.
|
||||||
|
|
||||||
|
A "covered work" means either the unmodified Program or a work based
|
||||||
|
on the Program.
|
||||||
|
|
||||||
|
To "propagate" a work means to do anything with it that, without
|
||||||
|
permission, would make you directly or secondarily liable for
|
||||||
|
infringement under applicable copyright law, except executing it on a
|
||||||
|
computer or modifying a private copy. Propagation includes copying,
|
||||||
|
distribution (with or without modification), making available to the
|
||||||
|
public, and in some countries other activities as well.
|
||||||
|
|
||||||
|
To "convey" a work means any kind of propagation that enables other
|
||||||
|
parties to make or receive copies. Mere interaction with a user through
|
||||||
|
a computer network, with no transfer of a copy, is not conveying.
|
||||||
|
|
||||||
|
An interactive user interface displays "Appropriate Legal Notices"
|
||||||
|
to the extent that it includes a convenient and prominently visible
|
||||||
|
feature that (1) displays an appropriate copyright notice, and (2)
|
||||||
|
tells the user that there is no warranty for the work (except to the
|
||||||
|
extent that warranties are provided), that licensees may convey the
|
||||||
|
work under this License, and how to view a copy of this License. If
|
||||||
|
the interface presents a list of user commands or options, such as a
|
||||||
|
menu, a prominent item in the list meets this criterion.
|
||||||
|
|
||||||
|
1. Source Code.
|
||||||
|
|
||||||
|
The "source code" for a work means the preferred form of the work
|
||||||
|
for making modifications to it. "Object code" means any non-source
|
||||||
|
form of a work.
|
||||||
|
|
||||||
|
A "Standard Interface" means an interface that either is an official
|
||||||
|
standard defined by a recognized standards body, or, in the case of
|
||||||
|
interfaces specified for a particular programming language, one that
|
||||||
|
is widely used among developers working in that language.
|
||||||
|
|
||||||
|
The "System Libraries" of an executable work include anything, other
|
||||||
|
than the work as a whole, that (a) is included in the normal form of
|
||||||
|
packaging a Major Component, but which is not part of that Major
|
||||||
|
Component, and (b) serves only to enable use of the work with that
|
||||||
|
Major Component, or to implement a Standard Interface for which an
|
||||||
|
implementation is available to the public in source code form. A
|
||||||
|
"Major Component", in this context, means a major essential component
|
||||||
|
(kernel, window system, and so on) of the specific operating system
|
||||||
|
(if any) on which the executable work runs, or a compiler used to
|
||||||
|
produce the work, or an object code interpreter used to run it.
|
||||||
|
|
||||||
|
The "Corresponding Source" for a work in object code form means all
|
||||||
|
the source code needed to generate, install, and (for an executable
|
||||||
|
work) run the object code and to modify the work, including scripts to
|
||||||
|
control those activities. However, it does not include the work's
|
||||||
|
System Libraries, or general-purpose tools or generally available free
|
||||||
|
programs which are used unmodified in performing those activities but
|
||||||
|
which are not part of the work. For example, Corresponding Source
|
||||||
|
includes interface definition files associated with source files for
|
||||||
|
the work, and the source code for shared libraries and dynamically
|
||||||
|
linked subprograms that the work is specifically designed to require,
|
||||||
|
such as by intimate data communication or control flow between those
|
||||||
|
subprograms and other parts of the work.
|
||||||
|
|
||||||
|
The Corresponding Source need not include anything that users
|
||||||
|
can regenerate automatically from other parts of the Corresponding
|
||||||
|
Source.
|
||||||
|
|
||||||
|
The Corresponding Source for a work in source code form is that
|
||||||
|
same work.
|
||||||
|
|
||||||
|
2. Basic Permissions.
|
||||||
|
|
||||||
|
All rights granted under this License are granted for the term of
|
||||||
|
copyright on the Program, and are irrevocable provided the stated
|
||||||
|
conditions are met. This License explicitly affirms your unlimited
|
||||||
|
permission to run the unmodified Program. The output from running a
|
||||||
|
covered work is covered by this License only if the output, given its
|
||||||
|
content, constitutes a covered work. This License acknowledges your
|
||||||
|
rights of fair use or other equivalent, as provided by copyright law.
|
||||||
|
|
||||||
|
You may make, run and propagate covered works that you do not
|
||||||
|
convey, without conditions so long as your license otherwise remains
|
||||||
|
in force. You may convey covered works to others for the sole purpose
|
||||||
|
of having them make modifications exclusively for you, or provide you
|
||||||
|
with facilities for running those works, provided that you comply with
|
||||||
|
the terms of this License in conveying all material for which you do
|
||||||
|
not control copyright. Those thus making or running the covered works
|
||||||
|
for you must do so exclusively on your behalf, under your direction
|
||||||
|
and control, on terms that prohibit them from making any copies of
|
||||||
|
your copyrighted material outside their relationship with you.
|
||||||
|
|
||||||
|
Conveying under any other circumstances is permitted solely under
|
||||||
|
the conditions stated below. Sublicensing is not allowed; section 10
|
||||||
|
makes it unnecessary.
|
||||||
|
|
||||||
|
3. Protecting Users' Legal Rights From Anti-Circumvention Law.
|
||||||
|
|
||||||
|
No covered work shall be deemed part of an effective technological
|
||||||
|
measure under any applicable law fulfilling obligations under article
|
||||||
|
11 of the WIPO copyright treaty adopted on 20 December 1996, or
|
||||||
|
similar laws prohibiting or restricting circumvention of such
|
||||||
|
measures.
|
||||||
|
|
||||||
|
When you convey a covered work, you waive any legal power to forbid
|
||||||
|
circumvention of technological measures to the extent such circumvention
|
||||||
|
is effected by exercising rights under this License with respect to
|
||||||
|
the covered work, and you disclaim any intention to limit operation or
|
||||||
|
modification of the work as a means of enforcing, against the work's
|
||||||
|
users, your or third parties' legal rights to forbid circumvention of
|
||||||
|
technological measures.
|
||||||
|
|
||||||
|
4. Conveying Verbatim Copies.
|
||||||
|
|
||||||
|
You may convey verbatim copies of the Program's source code as you
|
||||||
|
receive it, in any medium, provided that you conspicuously and
|
||||||
|
appropriately publish on each copy an appropriate copyright notice;
|
||||||
|
keep intact all notices stating that this License and any
|
||||||
|
non-permissive terms added in accord with section 7 apply to the code;
|
||||||
|
keep intact all notices of the absence of any warranty; and give all
|
||||||
|
recipients a copy of this License along with the Program.
|
||||||
|
|
||||||
|
You may charge any price or no price for each copy that you convey,
|
||||||
|
and you may offer support or warranty protection for a fee.
|
||||||
|
|
||||||
|
5. Conveying Modified Source Versions.
|
||||||
|
|
||||||
|
You may convey a work based on the Program, or the modifications to
|
||||||
|
produce it from the Program, in the form of source code under the
|
||||||
|
terms of section 4, provided that you also meet all of these conditions:
|
||||||
|
|
||||||
|
a) The work must carry prominent notices stating that you modified
|
||||||
|
it, and giving a relevant date.
|
||||||
|
|
||||||
|
b) The work must carry prominent notices stating that it is
|
||||||
|
released under this License and any conditions added under section
|
||||||
|
7. This requirement modifies the requirement in section 4 to
|
||||||
|
"keep intact all notices".
|
||||||
|
|
||||||
|
c) You must license the entire work, as a whole, under this
|
||||||
|
License to anyone who comes into possession of a copy. This
|
||||||
|
License will therefore apply, along with any applicable section 7
|
||||||
|
additional terms, to the whole of the work, and all its parts,
|
||||||
|
regardless of how they are packaged. This License gives no
|
||||||
|
permission to license the work in any other way, but it does not
|
||||||
|
invalidate such permission if you have separately received it.
|
||||||
|
|
||||||
|
d) If the work has interactive user interfaces, each must display
|
||||||
|
Appropriate Legal Notices; however, if the Program has interactive
|
||||||
|
interfaces that do not display Appropriate Legal Notices, your
|
||||||
|
work need not make them do so.
|
||||||
|
|
||||||
|
A compilation of a covered work with other separate and independent
|
||||||
|
works, which are not by their nature extensions of the covered work,
|
||||||
|
and which are not combined with it such as to form a larger program,
|
||||||
|
in or on a volume of a storage or distribution medium, is called an
|
||||||
|
"aggregate" if the compilation and its resulting copyright are not
|
||||||
|
used to limit the access or legal rights of the compilation's users
|
||||||
|
beyond what the individual works permit. Inclusion of a covered work
|
||||||
|
in an aggregate does not cause this License to apply to the other
|
||||||
|
parts of the aggregate.
|
||||||
|
|
||||||
|
6. Conveying Non-Source Forms.
|
||||||
|
|
||||||
|
You may convey a covered work in object code form under the terms
|
||||||
|
of sections 4 and 5, provided that you also convey the
|
||||||
|
machine-readable Corresponding Source under the terms of this License,
|
||||||
|
in one of these ways:
|
||||||
|
|
||||||
|
a) Convey the object code in, or embodied in, a physical product
|
||||||
|
(including a physical distribution medium), accompanied by the
|
||||||
|
Corresponding Source fixed on a durable physical medium
|
||||||
|
customarily used for software interchange.
|
||||||
|
|
||||||
|
b) Convey the object code in, or embodied in, a physical product
|
||||||
|
(including a physical distribution medium), accompanied by a
|
||||||
|
written offer, valid for at least three years and valid for as
|
||||||
|
long as you offer spare parts or customer support for that product
|
||||||
|
model, to give anyone who possesses the object code either (1) a
|
||||||
|
copy of the Corresponding Source for all the software in the
|
||||||
|
product that is covered by this License, on a durable physical
|
||||||
|
medium customarily used for software interchange, for a price no
|
||||||
|
more than your reasonable cost of physically performing this
|
||||||
|
conveying of source, or (2) access to copy the
|
||||||
|
Corresponding Source from a network server at no charge.
|
||||||
|
|
||||||
|
c) Convey individual copies of the object code with a copy of the
|
||||||
|
written offer to provide the Corresponding Source. This
|
||||||
|
alternative is allowed only occasionally and noncommercially, and
|
||||||
|
only if you received the object code with such an offer, in accord
|
||||||
|
with subsection 6b.
|
||||||
|
|
||||||
|
d) Convey the object code by offering access from a designated
|
||||||
|
place (gratis or for a charge), and offer equivalent access to the
|
||||||
|
Corresponding Source in the same way through the same place at no
|
||||||
|
further charge. You need not require recipients to copy the
|
||||||
|
Corresponding Source along with the object code. If the place to
|
||||||
|
copy the object code is a network server, the Corresponding Source
|
||||||
|
may be on a different server (operated by you or a third party)
|
||||||
|
that supports equivalent copying facilities, provided you maintain
|
||||||
|
clear directions next to the object code saying where to find the
|
||||||
|
Corresponding Source. Regardless of what server hosts the
|
||||||
|
Corresponding Source, you remain obligated to ensure that it is
|
||||||
|
available for as long as needed to satisfy these requirements.
|
||||||
|
|
||||||
|
e) Convey the object code using peer-to-peer transmission, provided
|
||||||
|
you inform other peers where the object code and Corresponding
|
||||||
|
Source of the work are being offered to the general public at no
|
||||||
|
charge under subsection 6d.
|
||||||
|
|
||||||
|
A separable portion of the object code, whose source code is excluded
|
||||||
|
from the Corresponding Source as a System Library, need not be
|
||||||
|
included in conveying the object code work.
|
||||||
|
|
||||||
|
A "User Product" is either (1) a "consumer product", which means any
|
||||||
|
tangible personal property which is normally used for personal, family,
|
||||||
|
or household purposes, or (2) anything designed or sold for incorporation
|
||||||
|
into a dwelling. In determining whether a product is a consumer product,
|
||||||
|
doubtful cases shall be resolved in favor of coverage. For a particular
|
||||||
|
product received by a particular user, "normally used" refers to a
|
||||||
|
typical or common use of that class of product, regardless of the status
|
||||||
|
of the particular user or of the way in which the particular user
|
||||||
|
actually uses, or expects or is expected to use, the product. A product
|
||||||
|
is a consumer product regardless of whether the product has substantial
|
||||||
|
commercial, industrial or non-consumer uses, unless such uses represent
|
||||||
|
the only significant mode of use of the product.
|
||||||
|
|
||||||
|
"Installation Information" for a User Product means any methods,
|
||||||
|
procedures, authorization keys, or other information required to install
|
||||||
|
and execute modified versions of a covered work in that User Product from
|
||||||
|
a modified version of its Corresponding Source. The information must
|
||||||
|
suffice to ensure that the continued functioning of the modified object
|
||||||
|
code is in no case prevented or interfered with solely because
|
||||||
|
modification has been made.
|
||||||
|
|
||||||
|
If you convey an object code work under this section in, or with, or
|
||||||
|
specifically for use in, a User Product, and the conveying occurs as
|
||||||
|
part of a transaction in which the right of possession and use of the
|
||||||
|
User Product is transferred to the recipient in perpetuity or for a
|
||||||
|
fixed term (regardless of how the transaction is characterized), the
|
||||||
|
Corresponding Source conveyed under this section must be accompanied
|
||||||
|
by the Installation Information. But this requirement does not apply
|
||||||
|
if neither you nor any third party retains the ability to install
|
||||||
|
modified object code on the User Product (for example, the work has
|
||||||
|
been installed in ROM).
|
||||||
|
|
||||||
|
The requirement to provide Installation Information does not include a
|
||||||
|
requirement to continue to provide support service, warranty, or updates
|
||||||
|
for a work that has been modified or installed by the recipient, or for
|
||||||
|
the User Product in which it has been modified or installed. Access to a
|
||||||
|
network may be denied when the modification itself materially and
|
||||||
|
adversely affects the operation of the network or violates the rules and
|
||||||
|
protocols for communication across the network.
|
||||||
|
|
||||||
|
Corresponding Source conveyed, and Installation Information provided,
|
||||||
|
in accord with this section must be in a format that is publicly
|
||||||
|
documented (and with an implementation available to the public in
|
||||||
|
source code form), and must require no special password or key for
|
||||||
|
unpacking, reading or copying.
|
||||||
|
|
||||||
|
7. Additional Terms.
|
||||||
|
|
||||||
|
"Additional permissions" are terms that supplement the terms of this
|
||||||
|
License by making exceptions from one or more of its conditions.
|
||||||
|
Additional permissions that are applicable to the entire Program shall
|
||||||
|
be treated as though they were included in this License, to the extent
|
||||||
|
that they are valid under applicable law. If additional permissions
|
||||||
|
apply only to part of the Program, that part may be used separately
|
||||||
|
under those permissions, but the entire Program remains governed by
|
||||||
|
this License without regard to the additional permissions.
|
||||||
|
|
||||||
|
When you convey a copy of a covered work, you may at your option
|
||||||
|
remove any additional permissions from that copy, or from any part of
|
||||||
|
it. (Additional permissions may be written to require their own
|
||||||
|
removal in certain cases when you modify the work.) You may place
|
||||||
|
additional permissions on material, added by you to a covered work,
|
||||||
|
for which you have or can give appropriate copyright permission.
|
||||||
|
|
||||||
|
Notwithstanding any other provision of this License, for material you
|
||||||
|
add to a covered work, you may (if authorized by the copyright holders of
|
||||||
|
that material) supplement the terms of this License with terms:
|
||||||
|
|
||||||
|
a) Disclaiming warranty or limiting liability differently from the
|
||||||
|
terms of sections 15 and 16 of this License; or
|
||||||
|
|
||||||
|
b) Requiring preservation of specified reasonable legal notices or
|
||||||
|
author attributions in that material or in the Appropriate Legal
|
||||||
|
Notices displayed by works containing it; or
|
||||||
|
|
||||||
|
c) Prohibiting misrepresentation of the origin of that material, or
|
||||||
|
requiring that modified versions of such material be marked in
|
||||||
|
reasonable ways as different from the original version; or
|
||||||
|
|
||||||
|
d) Limiting the use for publicity purposes of names of licensors or
|
||||||
|
authors of the material; or
|
||||||
|
|
||||||
|
e) Declining to grant rights under trademark law for use of some
|
||||||
|
trade names, trademarks, or service marks; or
|
||||||
|
|
||||||
|
f) Requiring indemnification of licensors and authors of that
|
||||||
|
material by anyone who conveys the material (or modified versions of
|
||||||
|
it) with contractual assumptions of liability to the recipient, for
|
||||||
|
any liability that these contractual assumptions directly impose on
|
||||||
|
those licensors and authors.
|
||||||
|
|
||||||
|
All other non-permissive additional terms are considered "further
|
||||||
|
restrictions" within the meaning of section 10. If the Program as you
|
||||||
|
received it, or any part of it, contains a notice stating that it is
|
||||||
|
governed by this License along with a term that is a further
|
||||||
|
restriction, you may remove that term. If a license document contains
|
||||||
|
a further restriction but permits relicensing or conveying under this
|
||||||
|
License, you may add to a covered work material governed by the terms
|
||||||
|
of that license document, provided that the further restriction does
|
||||||
|
not survive such relicensing or conveying.
|
||||||
|
|
||||||
|
If you add terms to a covered work in accord with this section, you
|
||||||
|
must place, in the relevant source files, a statement of the
|
||||||
|
additional terms that apply to those files, or a notice indicating
|
||||||
|
where to find the applicable terms.
|
||||||
|
|
||||||
|
Additional terms, permissive or non-permissive, may be stated in the
|
||||||
|
form of a separately written license, or stated as exceptions;
|
||||||
|
the above requirements apply either way.
|
||||||
|
|
||||||
|
8. Termination.
|
||||||
|
|
||||||
|
You may not propagate or modify a covered work except as expressly
|
||||||
|
provided under this License. Any attempt otherwise to propagate or
|
||||||
|
modify it is void, and will automatically terminate your rights under
|
||||||
|
this License (including any patent licenses granted under the third
|
||||||
|
paragraph of section 11).
|
||||||
|
|
||||||
|
However, if you cease all violation of this License, then your
|
||||||
|
license from a particular copyright holder is reinstated (a)
|
||||||
|
provisionally, unless and until the copyright holder explicitly and
|
||||||
|
finally terminates your license, and (b) permanently, if the copyright
|
||||||
|
holder fails to notify you of the violation by some reasonable means
|
||||||
|
prior to 60 days after the cessation.
|
||||||
|
|
||||||
|
Moreover, your license from a particular copyright holder is
|
||||||
|
reinstated permanently if the copyright holder notifies you of the
|
||||||
|
violation by some reasonable means, this is the first time you have
|
||||||
|
received notice of violation of this License (for any work) from that
|
||||||
|
copyright holder, and you cure the violation prior to 30 days after
|
||||||
|
your receipt of the notice.
|
||||||
|
|
||||||
|
Termination of your rights under this section does not terminate the
|
||||||
|
licenses of parties who have received copies or rights from you under
|
||||||
|
this License. If your rights have been terminated and not permanently
|
||||||
|
reinstated, you do not qualify to receive new licenses for the same
|
||||||
|
material under section 10.
|
||||||
|
|
||||||
|
9. Acceptance Not Required for Having Copies.
|
||||||
|
|
||||||
|
You are not required to accept this License in order to receive or
|
||||||
|
run a copy of the Program. Ancillary propagation of a covered work
|
||||||
|
occurring solely as a consequence of using peer-to-peer transmission
|
||||||
|
to receive a copy likewise does not require acceptance. However,
|
||||||
|
nothing other than this License grants you permission to propagate or
|
||||||
|
modify any covered work. These actions infringe copyright if you do
|
||||||
|
not accept this License. Therefore, by modifying or propagating a
|
||||||
|
covered work, you indicate your acceptance of this License to do so.
|
||||||
|
|
||||||
|
10. Automatic Licensing of Downstream Recipients.
|
||||||
|
|
||||||
|
Each time you convey a covered work, the recipient automatically
|
||||||
|
receives a license from the original licensors, to run, modify and
|
||||||
|
propagate that work, subject to this License. You are not responsible
|
||||||
|
for enforcing compliance by third parties with this License.
|
||||||
|
|
||||||
|
An "entity transaction" is a transaction transferring control of an
|
||||||
|
organization, or substantially all assets of one, or subdividing an
|
||||||
|
organization, or merging organizations. If propagation of a covered
|
||||||
|
work results from an entity transaction, each party to that
|
||||||
|
transaction who receives a copy of the work also receives whatever
|
||||||
|
licenses to the work the party's predecessor in interest had or could
|
||||||
|
give under the previous paragraph, plus a right to possession of the
|
||||||
|
Corresponding Source of the work from the predecessor in interest, if
|
||||||
|
the predecessor has it or can get it with reasonable efforts.
|
||||||
|
|
||||||
|
You may not impose any further restrictions on the exercise of the
|
||||||
|
rights granted or affirmed under this License. For example, you may
|
||||||
|
not impose a license fee, royalty, or other charge for exercise of
|
||||||
|
rights granted under this License, and you may not initiate litigation
|
||||||
|
(including a cross-claim or counterclaim in a lawsuit) alleging that
|
||||||
|
any patent claim is infringed by making, using, selling, offering for
|
||||||
|
sale, or importing the Program or any portion of it.
|
||||||
|
|
||||||
|
11. Patents.
|
||||||
|
|
||||||
|
A "contributor" is a copyright holder who authorizes use under this
|
||||||
|
License of the Program or a work on which the Program is based. The
|
||||||
|
work thus licensed is called the contributor's "contributor version".
|
||||||
|
|
||||||
|
A contributor's "essential patent claims" are all patent claims
|
||||||
|
owned or controlled by the contributor, whether already acquired or
|
||||||
|
hereafter acquired, that would be infringed by some manner, permitted
|
||||||
|
by this License, of making, using, or selling its contributor version,
|
||||||
|
but do not include claims that would be infringed only as a
|
||||||
|
consequence of further modification of the contributor version. For
|
||||||
|
purposes of this definition, "control" includes the right to grant
|
||||||
|
patent sublicenses in a manner consistent with the requirements of
|
||||||
|
this License.
|
||||||
|
|
||||||
|
Each contributor grants you a non-exclusive, worldwide, royalty-free
|
||||||
|
patent license under the contributor's essential patent claims, to
|
||||||
|
make, use, sell, offer for sale, import and otherwise run, modify and
|
||||||
|
propagate the contents of its contributor version.
|
||||||
|
|
||||||
|
In the following three paragraphs, a "patent license" is any express
|
||||||
|
agreement or commitment, however denominated, not to enforce a patent
|
||||||
|
(such as an express permission to practice a patent or covenant not to
|
||||||
|
sue for patent infringement). To "grant" such a patent license to a
|
||||||
|
party means to make such an agreement or commitment not to enforce a
|
||||||
|
patent against the party.
|
||||||
|
|
||||||
|
If you convey a covered work, knowingly relying on a patent license,
|
||||||
|
and the Corresponding Source of the work is not available for anyone
|
||||||
|
to copy, free of charge and under the terms of this License, through a
|
||||||
|
publicly available network server or other readily accessible means,
|
||||||
|
then you must either (1) cause the Corresponding Source to be so
|
||||||
|
available, or (2) arrange to deprive yourself of the benefit of the
|
||||||
|
patent license for this particular work, or (3) arrange, in a manner
|
||||||
|
consistent with the requirements of this License, to extend the patent
|
||||||
|
license to downstream recipients. "Knowingly relying" means you have
|
||||||
|
actual knowledge that, but for the patent license, your conveying the
|
||||||
|
covered work in a country, or your recipient's use of the covered work
|
||||||
|
in a country, would infringe one or more identifiable patents in that
|
||||||
|
country that you have reason to believe are valid.
|
||||||
|
|
||||||
|
If, pursuant to or in connection with a single transaction or
|
||||||
|
arrangement, you convey, or propagate by procuring conveyance of, a
|
||||||
|
covered work, and grant a patent license to some of the parties
|
||||||
|
receiving the covered work authorizing them to use, propagate, modify
|
||||||
|
or convey a specific copy of the covered work, then the patent license
|
||||||
|
you grant is automatically extended to all recipients of the covered
|
||||||
|
work and works based on it.
|
||||||
|
|
||||||
|
A patent license is "discriminatory" if it does not include within
|
||||||
|
the scope of its coverage, prohibits the exercise of, or is
|
||||||
|
conditioned on the non-exercise of one or more of the rights that are
|
||||||
|
specifically granted under this License. You may not convey a covered
|
||||||
|
work if you are a party to an arrangement with a third party that is
|
||||||
|
in the business of distributing software, under which you make payment
|
||||||
|
to the third party based on the extent of your activity of conveying
|
||||||
|
the work, and under which the third party grants, to any of the
|
||||||
|
parties who would receive the covered work from you, a discriminatory
|
||||||
|
patent license (a) in connection with copies of the covered work
|
||||||
|
conveyed by you (or copies made from those copies), or (b) primarily
|
||||||
|
for and in connection with specific products or compilations that
|
||||||
|
contain the covered work, unless you entered into that arrangement,
|
||||||
|
or that patent license was granted, prior to 28 March 2007.
|
||||||
|
|
||||||
|
Nothing in this License shall be construed as excluding or limiting
|
||||||
|
any implied license or other defenses to infringement that may
|
||||||
|
otherwise be available to you under applicable patent law.
|
||||||
|
|
||||||
|
12. No Surrender of Others' Freedom.
|
||||||
|
|
||||||
|
If conditions are imposed on you (whether by court order, agreement or
|
||||||
|
otherwise) that contradict the conditions of this License, they do not
|
||||||
|
excuse you from the conditions of this License. If you cannot convey a
|
||||||
|
covered work so as to satisfy simultaneously your obligations under this
|
||||||
|
License and any other pertinent obligations, then as a consequence you may
|
||||||
|
not convey it at all. For example, if you agree to terms that obligate you
|
||||||
|
to collect a royalty for further conveying from those to whom you convey
|
||||||
|
the Program, the only way you could satisfy both those terms and this
|
||||||
|
License would be to refrain entirely from conveying the Program.
|
||||||
|
|
||||||
|
13. Use with the GNU Affero General Public License.
|
||||||
|
|
||||||
|
Notwithstanding any other provision of this License, you have
|
||||||
|
permission to link or combine any covered work with a work licensed
|
||||||
|
under version 3 of the GNU Affero General Public License into a single
|
||||||
|
combined work, and to convey the resulting work. The terms of this
|
||||||
|
License will continue to apply to the part which is the covered work,
|
||||||
|
but the special requirements of the GNU Affero General Public License,
|
||||||
|
section 13, concerning interaction through a network will apply to the
|
||||||
|
combination as such.
|
||||||
|
|
||||||
|
14. Revised Versions of this License.
|
||||||
|
|
||||||
|
The Free Software Foundation may publish revised and/or new versions of
|
||||||
|
the GNU General Public License from time to time. Such new versions will
|
||||||
|
be similar in spirit to the present version, but may differ in detail to
|
||||||
|
address new problems or concerns.
|
||||||
|
|
||||||
|
Each version is given a distinguishing version number. If the
|
||||||
|
Program specifies that a certain numbered version of the GNU General
|
||||||
|
Public License "or any later version" applies to it, you have the
|
||||||
|
option of following the terms and conditions either of that numbered
|
||||||
|
version or of any later version published by the Free Software
|
||||||
|
Foundation. If the Program does not specify a version number of the
|
||||||
|
GNU General Public License, you may choose any version ever published
|
||||||
|
by the Free Software Foundation.
|
||||||
|
|
||||||
|
If the Program specifies that a proxy can decide which future
|
||||||
|
versions of the GNU General Public License can be used, that proxy's
|
||||||
|
public statement of acceptance of a version permanently authorizes you
|
||||||
|
to choose that version for the Program.
|
||||||
|
|
||||||
|
Later license versions may give you additional or different
|
||||||
|
permissions. However, no additional obligations are imposed on any
|
||||||
|
author or copyright holder as a result of your choosing to follow a
|
||||||
|
later version.
|
||||||
|
|
||||||
|
15. Disclaimer of Warranty.
|
||||||
|
|
||||||
|
THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY
|
||||||
|
APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT
|
||||||
|
HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY
|
||||||
|
OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO,
|
||||||
|
THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
|
||||||
|
PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM
|
||||||
|
IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF
|
||||||
|
ALL NECESSARY SERVICING, REPAIR OR CORRECTION.
|
||||||
|
|
||||||
|
16. Limitation of Liability.
|
||||||
|
|
||||||
|
IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING
|
||||||
|
WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS
|
||||||
|
THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY
|
||||||
|
GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE
|
||||||
|
USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF
|
||||||
|
DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD
|
||||||
|
PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS),
|
||||||
|
EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF
|
||||||
|
SUCH DAMAGES.
|
||||||
|
|
||||||
|
17. Interpretation of Sections 15 and 16.
|
||||||
|
|
||||||
|
If the disclaimer of warranty and limitation of liability provided
|
||||||
|
above cannot be given local legal effect according to their terms,
|
||||||
|
reviewing courts shall apply local law that most closely approximates
|
||||||
|
an absolute waiver of all civil liability in connection with the
|
||||||
|
Program, unless a warranty or assumption of liability accompanies a
|
||||||
|
copy of the Program in return for a fee.
|
||||||
|
|
||||||
|
END OF TERMS AND CONDITIONS
|
||||||
|
|
||||||
|
How to Apply These Terms to Your New Programs
|
||||||
|
|
||||||
|
If you develop a new program, and you want it to be of the greatest
|
||||||
|
possible use to the public, the best way to achieve this is to make it
|
||||||
|
free software which everyone can redistribute and change under these terms.
|
||||||
|
|
||||||
|
To do so, attach the following notices to the program. It is safest
|
||||||
|
to attach them to the start of each source file to most effectively
|
||||||
|
state the exclusion of warranty; and each file should have at least
|
||||||
|
the "copyright" line and a pointer to where the full notice is found.
|
||||||
|
|
||||||
|
<one line to give the program's name and a brief idea of what it does.>
|
||||||
|
Copyright (C) <year> <name of author>
|
||||||
|
|
||||||
|
This program is free software: you can redistribute it and/or modify
|
||||||
|
it under the terms of the GNU General Public License as published by
|
||||||
|
the Free Software Foundation, either version 3 of the License, or
|
||||||
|
(at your option) any later version.
|
||||||
|
|
||||||
|
This program is distributed in the hope that it will be useful,
|
||||||
|
but WITHOUT ANY WARRANTY; without even the implied warranty of
|
||||||
|
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
||||||
|
GNU General Public License for more details.
|
||||||
|
|
||||||
|
You should have received a copy of the GNU General Public License
|
||||||
|
along with this program. If not, see <https://www.gnu.org/licenses/>.
|
||||||
|
|
||||||
|
Also add information on how to contact you by electronic and paper mail.
|
||||||
|
|
||||||
|
If the program does terminal interaction, make it output a short
|
||||||
|
notice like this when it starts in an interactive mode:
|
||||||
|
|
||||||
|
<program> Copyright (C) <year> <name of author>
|
||||||
|
This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'.
|
||||||
|
This is free software, and you are welcome to redistribute it
|
||||||
|
under certain conditions; type `show c' for details.
|
||||||
|
|
||||||
|
The hypothetical commands `show w' and `show c' should show the appropriate
|
||||||
|
parts of the General Public License. Of course, your program's commands
|
||||||
|
might be different; for a GUI interface, you would use an "about box".
|
||||||
|
|
||||||
|
You should also get your employer (if you work as a programmer) or school,
|
||||||
|
if any, to sign a "copyright disclaimer" for the program, if necessary.
|
||||||
|
For more information on this, and how to apply and follow the GNU GPL, see
|
||||||
|
<https://www.gnu.org/licenses/>.
|
||||||
|
|
||||||
|
The GNU General Public License does not permit incorporating your program
|
||||||
|
into proprietary programs. If your program is a subroutine library, you
|
||||||
|
may consider it more useful to permit linking proprietary applications with
|
||||||
|
the library. If this is what you want to do, use the GNU Lesser General
|
||||||
|
Public License instead of this License. But first, please read
|
||||||
|
<https://www.gnu.org/licenses/why-not-lgpl.html>.
|
14
Makefile
14
Makefile
@@ -1,9 +1,11 @@
|
|||||||
install:
|
install:
|
||||||
cp notes2web.py /usr/local/bin
|
cp gronk_add_uuid.py /usr/local/bin
|
||||||
pip install -r requirements.txt
|
sed "s/GRONK_COMMIT = \"dev\"/GRONK_COMMIT = \"$$(git rev-parse --short HEAD)\"/" gronk.py > /usr/local/bin/gronk.py
|
||||||
mkdir -p /opt/notes2web
|
chmod +x /usr/local/bin/gronk.py
|
||||||
cp -r templates /opt/notes2web
|
chmod +x /usr/local/bin/gronk_add_uuid.py
|
||||||
cp styles.css /opt/notes2web
|
mkdir -p /opt/gronk
|
||||||
|
cp -r templates js css /opt/gronk
|
||||||
|
pip3 install -r requirements.txt
|
||||||
|
|
||||||
uninstall:
|
uninstall:
|
||||||
rm -rf /usr/local/bin/notes2web.py /opt/notes2web
|
rm -rf /usr/local/bin/gronk.py /usr/local/bin/gronk_add_uuid.py /opt/gronk
|
||||||
|
186
css/styles.css
Normal file
186
css/styles.css
Normal file
@@ -0,0 +1,186 @@
|
|||||||
|
@import url("https://styles.alv.cx/colors/gruvbox.css");
|
||||||
|
@import url("https://styles.alv.cx/base.css");
|
||||||
|
@import url("https://styles.alv.cx/modules/search.css");
|
||||||
|
@import url("https://styles.alv.cx/modules/buttonlist.css");
|
||||||
|
@import url("https://styles.alv.cx/modules/darkmode.css");
|
||||||
|
@import url("/notes/styles.css");
|
||||||
|
|
||||||
|
html {
|
||||||
|
scroll-behavior: smooth;
|
||||||
|
}
|
||||||
|
|
||||||
|
h1 { font-size: 2.5em }
|
||||||
|
h2 { font-size: 2em;}
|
||||||
|
h3 { font-size: 1.5em; }
|
||||||
|
|
||||||
|
body {
|
||||||
|
max-width: none;
|
||||||
|
width: 100%;
|
||||||
|
box-sizing: border-box;
|
||||||
|
}
|
||||||
|
|
||||||
|
.article {
|
||||||
|
margin: 1em;
|
||||||
|
}
|
||||||
|
|
||||||
|
.smallText {
|
||||||
|
font-size: 0.7em;
|
||||||
|
}
|
||||||
|
|
||||||
|
.article .smallText {
|
||||||
|
margin: 0
|
||||||
|
}
|
||||||
|
|
||||||
|
.matchHighlight {
|
||||||
|
background-color: var(--blue);
|
||||||
|
}
|
||||||
|
|
||||||
|
#sidebar > #header { padding-bottom: 1em; color: var(--fg-lc);}
|
||||||
|
|
||||||
|
#header > * {
|
||||||
|
margin: 0;
|
||||||
|
padding: 0;
|
||||||
|
}
|
||||||
|
|
||||||
|
#contentWrapper {
|
||||||
|
display: flex
|
||||||
|
}
|
||||||
|
|
||||||
|
|
||||||
|
#sidebar {
|
||||||
|
position: sticky;
|
||||||
|
top: 10vh;
|
||||||
|
height: 80vh;
|
||||||
|
max-width: 30em;
|
||||||
|
display: flex;
|
||||||
|
flex-direction: column;
|
||||||
|
min-width: 20em;
|
||||||
|
padding-right: 1em;
|
||||||
|
}
|
||||||
|
|
||||||
|
#content {
|
||||||
|
margin: 0 auto;
|
||||||
|
width: 60em;
|
||||||
|
max-width: 100%;
|
||||||
|
}
|
||||||
|
|
||||||
|
#commitlog, #license { padding: 0; }
|
||||||
|
|
||||||
|
#toc {
|
||||||
|
overflow-y: scroll;
|
||||||
|
overflow-x: visible;
|
||||||
|
max-width: 100%;
|
||||||
|
}
|
||||||
|
|
||||||
|
#sidebar,
|
||||||
|
#toc li > a {
|
||||||
|
color: var(--fg-lc);
|
||||||
|
}
|
||||||
|
|
||||||
|
#toc li, ul#articlelist { list-style: none; }
|
||||||
|
#toc ul, ul#articlelist { margin-left: 0.75em ; padding-left: 0.75em; }
|
||||||
|
#toc ul, ul#articlelist { border-left: 1px solid var(--fg-lc);}
|
||||||
|
#toc > ul { padding; none; padding: 0; margin: 0; border: none;max-width: 100%;}
|
||||||
|
li { padding: 0 !important; }
|
||||||
|
|
||||||
|
#toc li > a,
|
||||||
|
ul#articlelist > a{
|
||||||
|
text-decoration: none;
|
||||||
|
display: inline-block;
|
||||||
|
width: 100%;
|
||||||
|
transition: 0.5s;
|
||||||
|
padding: 0.5em;
|
||||||
|
box-sizing: border-box;
|
||||||
|
}
|
||||||
|
#toc li > a:hover,
|
||||||
|
ul#articlelist li a:hover {
|
||||||
|
background: var(--bg-lc);
|
||||||
|
color: black;
|
||||||
|
}
|
||||||
|
|
||||||
|
mjx-container {
|
||||||
|
overflow-x: auto;
|
||||||
|
}
|
||||||
|
|
||||||
|
p.metadata { margin: 0 }
|
||||||
|
|
||||||
|
@media (max-width: 80em) {
|
||||||
|
/* CSS that should be displayed if width is equal to or less than 60em goes here */
|
||||||
|
#contentWrapper { flex-direction: column }
|
||||||
|
#sidebar { position: static; width: 100%; max-width: none; height: auto; }
|
||||||
|
#tocWrapper { display: none }
|
||||||
|
}
|
||||||
|
|
||||||
|
|
||||||
|
/* ==============================================================================
|
||||||
|
Pygments (pandoc built-in style)
|
||||||
|
==============================================================================
|
||||||
|
Style based on Pygments' default colors.
|
||||||
|
|
||||||
|
This stylesheet was produced using Pandoc v2.7.2.
|
||||||
|
|
||||||
|
Pandoc is (c) 2006-2017 John MacFarlane (jgm@berkeley.edu).
|
||||||
|
Released under the GPL, version 2 or greater.
|
||||||
|
------------------------------------------------------------------------------
|
||||||
|
*/
|
||||||
|
a.sourceLine { display: inline-block; line-height: 1.25; }
|
||||||
|
a.sourceLine { pointer-events: none; color: inherit; text-decoration: inherit; }
|
||||||
|
a.sourceLine:empty { height: 1.2em; }
|
||||||
|
.sourceCode { overflow: visible; }
|
||||||
|
code.sourceCode { white-space: pre; position: relative; }
|
||||||
|
div.sourceCode { margin: 1em 0; }
|
||||||
|
pre.sourceCode { margin: 0; }
|
||||||
|
@media screen {
|
||||||
|
div.sourceCode { overflow: auto; }
|
||||||
|
}
|
||||||
|
@media print {
|
||||||
|
code.sourceCode { white-space: pre-wrap; }
|
||||||
|
a.sourceLine { text-indent: -1em; padding-left: 1em; }
|
||||||
|
}
|
||||||
|
pre.numberSource a.sourceLine
|
||||||
|
{ position: relative; left: -4em; }
|
||||||
|
pre.numberSource a.sourceLine::before
|
||||||
|
{ content: attr(title);
|
||||||
|
position: relative; left: -1em; text-align: right; vertical-align: baseline;
|
||||||
|
border: none; pointer-events: all; display: inline-block;
|
||||||
|
-webkit-touch-callout: none; -webkit-user-select: none;
|
||||||
|
-khtml-user-select: none; -moz-user-select: none;
|
||||||
|
-ms-user-select: none; user-select: none;
|
||||||
|
padding: 0 4px; width: 4em;
|
||||||
|
color: #aaaaaa;
|
||||||
|
}
|
||||||
|
pre.numberSource { margin-left: 3em; border-left: 1px solid #aaaaaa; padding-left: 4px; }
|
||||||
|
div.sourceCode
|
||||||
|
{ }
|
||||||
|
@media screen {
|
||||||
|
a.sourceLine::before { text-decoration: underline; }
|
||||||
|
}
|
||||||
|
code span.al { color: #ff0000; font-weight: bold; } /* Alert */
|
||||||
|
code span.an { color: #60a0b0; font-weight: bold; font-style: italic; } /* Annotation */
|
||||||
|
code span.at { color: #7d9029; } /* Attribute */
|
||||||
|
code span.bn { color: #40a070; } /* BaseN */
|
||||||
|
code span.bu { } /* BuiltIn */
|
||||||
|
code span.cf { color: #007020; font-weight: bold; } /* ControlFlow */
|
||||||
|
code span.ch { color: #4070a0; } /* Char */
|
||||||
|
code span.cn { color: #880000; } /* Constant */
|
||||||
|
code span.co { color: #60a0b0; font-style: italic; } /* Comment */
|
||||||
|
code span.cv { color: #60a0b0; font-weight: bold; font-style: italic; } /* CommentVar */
|
||||||
|
code span.do { color: #ba2121; font-style: italic; } /* Documentation */
|
||||||
|
code span.dt { color: #902000; } /* DataType */
|
||||||
|
code span.dv { color: #40a070; } /* DecVal */
|
||||||
|
code span.er { color: #ff0000; font-weight: bold; } /* Error */
|
||||||
|
code span.ex { } /* Extension */
|
||||||
|
code span.fl { color: #40a070; } /* Float */
|
||||||
|
code span.fu { color: #06287e; } /* Function */
|
||||||
|
code span.im { } /* Import */
|
||||||
|
code span.in { color: #60a0b0; font-weight: bold; font-style: italic; } /* Information */
|
||||||
|
code span.kw { color: #007020; font-weight: bold; } /* Keyword */
|
||||||
|
code span.op { color: #666666; } /* Operator */
|
||||||
|
code span.ot { color: #007020; } /* Other */
|
||||||
|
code span.pp { color: #bc7a00; } /* Preprocessor */
|
||||||
|
code span.sc { color: #4070a0; } /* SpecialChar */
|
||||||
|
code span.ss { color: #bb6688; } /* SpecialString */
|
||||||
|
code span.st { color: #4070a0; } /* String */
|
||||||
|
code span.va { color: #19177c; } /* Variable */
|
||||||
|
code span.vs { color: #4070a0; } /* VerbatimString */
|
||||||
|
code span.wa { color: #60a0b0; font-weight: bold; font-style: italic; } /* Warning */
|
11
docker-compose.yml
Normal file
11
docker-compose.yml
Normal file
@@ -0,0 +1,11 @@
|
|||||||
|
version: '3'
|
||||||
|
|
||||||
|
services:
|
||||||
|
gronk:
|
||||||
|
build:
|
||||||
|
context: '.'
|
||||||
|
args:
|
||||||
|
ARCH: ${ARCH}
|
||||||
|
volumes:
|
||||||
|
- '${SOURCE}:/usr/src/app/notes'
|
||||||
|
- '${OUTPUT}:/usr/src/app/web'
|
552
gronk.py
Executable file
552
gronk.py
Executable file
@@ -0,0 +1,552 @@
|
|||||||
|
#!/usr/bin/env python3
|
||||||
|
"""
|
||||||
|
gronk --- view your notes as a static html site
|
||||||
|
"""
|
||||||
|
|
||||||
|
import argparse
|
||||||
|
import os
|
||||||
|
from pathlib import Path
|
||||||
|
import shutil
|
||||||
|
import sys
|
||||||
|
import subprocess
|
||||||
|
import copy
|
||||||
|
import time
|
||||||
|
import magic
|
||||||
|
import regex as re
|
||||||
|
import pprint
|
||||||
|
|
||||||
|
import frontmatter
|
||||||
|
import jinja2
|
||||||
|
import requests
|
||||||
|
|
||||||
|
GRONK_COMMIT = "dev"
|
||||||
|
|
||||||
|
PANDOC_SERVER_URL = os.getenv("PANDOC_SERVER_URL", r"http://localhost:3030/")
|
||||||
|
PANDOC_TIMEOUT = int(os.getenv("PANDOC_TIMEOUT", "120"))
|
||||||
|
GRONK_CSS_DIR = Path(os.getenv("GRONK_CSS_DIR", "/opt/gronk/css"))
|
||||||
|
GRONK_JS_DIR = Path(os.getenv("GRONK_JS_DIR", "/opt/gronk/js"))
|
||||||
|
GRONK_TEMPLATES_DIR = Path(
|
||||||
|
os.getenv("GRONK_TEMPLATES_DIR", "/opt/gronk/templates/"))
|
||||||
|
|
||||||
|
JINJA_ENV = jinja2.Environment(
|
||||||
|
loader=jinja2.FileSystemLoader(searchpath=GRONK_TEMPLATES_DIR),
|
||||||
|
autoescape=jinja2.select_autoescape)
|
||||||
|
|
||||||
|
JINJA_TEMPLATE_TEXTARTICLE = JINJA_ENV.get_template("article-text.html")
|
||||||
|
JINJA_TEMPLATE_HOME_INDEX = JINJA_ENV.get_template("home.html")
|
||||||
|
JINJA_TEMPLATE_INDEX = JINJA_ENV.get_template("index.html")
|
||||||
|
JINJA_TEMPLATE_ARTICLE = JINJA_ENV.get_template("article.html")
|
||||||
|
JINJA_TEMPLATE_PERMALINK = JINJA_ENV.get_template("permalink.html")
|
||||||
|
|
||||||
|
LICENSE = None
|
||||||
|
FILEMAP = None
|
||||||
|
|
||||||
|
|
||||||
|
class FileMap:
|
||||||
|
"""
|
||||||
|
this class is used to read file properties, inherit properties,
|
||||||
|
and have a centralised place to access them
|
||||||
|
"""
|
||||||
|
|
||||||
|
def __init__(self, input_dir, output_dir):
|
||||||
|
self._map = {}
|
||||||
|
self.input_dir = Path(input_dir)
|
||||||
|
self.output_dir = Path(output_dir)
|
||||||
|
|
||||||
|
@staticmethod
|
||||||
|
def _path_to_key(path):
|
||||||
|
return str(path)
|
||||||
|
|
||||||
|
@staticmethod
|
||||||
|
def is_plaintext(filename):
|
||||||
|
return re.match(r'^text/', magic.from_file(str(filename),
|
||||||
|
mime=True)) is not None
|
||||||
|
|
||||||
|
def add(self, filepath):
|
||||||
|
filepath = Path(filepath)
|
||||||
|
if filepath.is_dir():
|
||||||
|
properties = self._get_directory_properties(filepath)
|
||||||
|
else:
|
||||||
|
properties = self._get_file_properties(filepath)
|
||||||
|
|
||||||
|
properties['src_path'] = filepath
|
||||||
|
properties['dst_path'] = self._get_output_filepath(filepath)
|
||||||
|
|
||||||
|
self._map[self._path_to_key(filepath)] = properties
|
||||||
|
|
||||||
|
def get(self, filepath, default=None, raw=False):
|
||||||
|
"""
|
||||||
|
get the properties of a file at a filepath
|
||||||
|
raw=True to not inherit properties
|
||||||
|
"""
|
||||||
|
# TODO maybe store properties of a file once it's in built and mark it
|
||||||
|
# as built? might save time but also cba
|
||||||
|
if self._path_to_key(filepath) not in self._map.keys():
|
||||||
|
self.add(filepath)
|
||||||
|
|
||||||
|
properties = copy.deepcopy(
|
||||||
|
self._map.get(self._path_to_key(filepath), default))
|
||||||
|
|
||||||
|
if raw:
|
||||||
|
return properties
|
||||||
|
|
||||||
|
parent = filepath
|
||||||
|
while True:
|
||||||
|
parent = parent.parent
|
||||||
|
if parent == Path('.'):
|
||||||
|
break
|
||||||
|
|
||||||
|
parent_properties = self.get(parent, raw=True)
|
||||||
|
# TODO inherit any property that isn't defined, append any lists
|
||||||
|
# that exist
|
||||||
|
properties['tags'] = properties.get(
|
||||||
|
'tags', []) + parent_properties.get('tags', [])
|
||||||
|
|
||||||
|
if parent == self.input_dir:
|
||||||
|
break
|
||||||
|
|
||||||
|
return properties
|
||||||
|
|
||||||
|
def _get_directory_properties(self,
|
||||||
|
filepath: Path,
|
||||||
|
include_index_entries=True):
|
||||||
|
post = {
|
||||||
|
'title': filepath.name,
|
||||||
|
'content_after_search': False,
|
||||||
|
'automatic_index': True,
|
||||||
|
'search_bar': True,
|
||||||
|
'tags': [],
|
||||||
|
}
|
||||||
|
|
||||||
|
if 'readme.md' in [f.name for f in filepath.iterdir()]:
|
||||||
|
with open(filepath.joinpath('readme.md'),
|
||||||
|
encoding='utf-8') as file_pointer:
|
||||||
|
for key, val in frontmatter.load(
|
||||||
|
file_pointer).to_dict().items():
|
||||||
|
post[key] = val
|
||||||
|
|
||||||
|
if 'content' in post.keys():
|
||||||
|
post['content'] = render_markdown(post['content'])
|
||||||
|
|
||||||
|
post['is_dir'] = True
|
||||||
|
|
||||||
|
if include_index_entries:
|
||||||
|
post['index_entries'] = self._get_index_entries(filepath)
|
||||||
|
|
||||||
|
return post
|
||||||
|
|
||||||
|
def _get_index_entries(self, filepath):
|
||||||
|
entries = []
|
||||||
|
|
||||||
|
for path in filepath.iterdir():
|
||||||
|
if '.git' in path.parts:
|
||||||
|
continue
|
||||||
|
|
||||||
|
if path.is_dir():
|
||||||
|
entry = self._get_directory_properties(
|
||||||
|
path, include_index_entries=False)
|
||||||
|
else:
|
||||||
|
entry = self._get_file_properties(path)
|
||||||
|
|
||||||
|
entry['path'] = self._get_output_filepath(path)['web']
|
||||||
|
entries.append(entry)
|
||||||
|
|
||||||
|
entries.sort(key=lambda entry: str(entry.get('title', '')).lower())
|
||||||
|
entries.sort(key=lambda entry: entry['is_dir'], reverse=True)
|
||||||
|
|
||||||
|
return entries
|
||||||
|
|
||||||
|
def _get_file_properties(self, filepath):
|
||||||
|
post = {'title': filepath.name}
|
||||||
|
|
||||||
|
if filepath.suffix == '.md':
|
||||||
|
with open(filepath, encoding='utf-8') as file_pointer:
|
||||||
|
post = frontmatter.load(file_pointer).to_dict()
|
||||||
|
|
||||||
|
# don't store file contents in memory
|
||||||
|
if 'content' in post.keys():
|
||||||
|
del post['content']
|
||||||
|
post['is_dir'] = False
|
||||||
|
|
||||||
|
return post
|
||||||
|
|
||||||
|
def _get_output_filepath(self, input_filepath):
|
||||||
|
|
||||||
|
def webpath(filepath):
|
||||||
|
return Path('/notes').joinpath(
|
||||||
|
filepath.relative_to(self.output_dir))
|
||||||
|
|
||||||
|
r = {}
|
||||||
|
r['raw'] = self.output_dir.joinpath(
|
||||||
|
input_filepath.relative_to(self.input_dir))
|
||||||
|
r['web'] = webpath(r['raw'])
|
||||||
|
|
||||||
|
if input_filepath.is_dir():
|
||||||
|
return r
|
||||||
|
|
||||||
|
if input_filepath.suffix == '.md':
|
||||||
|
r['html'] = self.output_dir.joinpath(
|
||||||
|
input_filepath.relative_to(
|
||||||
|
self.input_dir)).with_suffix('.html')
|
||||||
|
r['web'] = webpath(r['html'])
|
||||||
|
|
||||||
|
elif self.is_plaintext(input_filepath):
|
||||||
|
r['html'] = self.output_dir.joinpath(
|
||||||
|
input_filepath.relative_to(
|
||||||
|
self.input_dir)).with_suffix(input_filepath.suffix +
|
||||||
|
'.html')
|
||||||
|
r['raw'] = self.output_dir.joinpath(
|
||||||
|
input_filepath.relative_to(self.input_dir))
|
||||||
|
r['web'] = webpath(r['html'])
|
||||||
|
|
||||||
|
return r
|
||||||
|
|
||||||
|
def to_list(self):
|
||||||
|
return [val for _, val in self._map.items()]
|
||||||
|
|
||||||
|
def to_search_data(self):
|
||||||
|
"""
|
||||||
|
returns list of every file in map
|
||||||
|
"""
|
||||||
|
r = []
|
||||||
|
for _, val in self._map.items():
|
||||||
|
r.append({
|
||||||
|
'title': val.get('title', ''),
|
||||||
|
'tags': val.get('tags', []),
|
||||||
|
'path': str(val['dst_path']['web']),
|
||||||
|
'is_dir': val['is_dir']
|
||||||
|
})
|
||||||
|
|
||||||
|
return r
|
||||||
|
|
||||||
|
def get_uuid_map(self):
|
||||||
|
d = {}
|
||||||
|
for _, val in self._map.items():
|
||||||
|
if 'uuid' not in val.keys():
|
||||||
|
continue
|
||||||
|
d[val['uuid']] = str(val['dst_path']['web'])
|
||||||
|
|
||||||
|
return d
|
||||||
|
|
||||||
|
|
||||||
|
def update_required(src_filepath, output_filepath):
|
||||||
|
"""
|
||||||
|
check if file requires an update,
|
||||||
|
return boolean
|
||||||
|
"""
|
||||||
|
return not output_filepath.exists() or src_filepath.stat(
|
||||||
|
).st_mtime > output_filepath.stat().st_mtimeme()
|
||||||
|
|
||||||
|
|
||||||
|
def get_args():
|
||||||
|
""" Get command line arguments """
|
||||||
|
|
||||||
|
parser = argparse.ArgumentParser()
|
||||||
|
parser.add_argument('notes', type=Path)
|
||||||
|
parser.add_argument('-o', '--output-dir', type=Path, default='web')
|
||||||
|
parser.add_argument(
|
||||||
|
'-F',
|
||||||
|
'--force',
|
||||||
|
action="store_true",
|
||||||
|
help=
|
||||||
|
"Generate new output html even if source file was modified before output html"
|
||||||
|
)
|
||||||
|
return parser.parse_args()
|
||||||
|
|
||||||
|
|
||||||
|
def render_markdown_file(input_filepath):
|
||||||
|
"""
|
||||||
|
render markdown file to file
|
||||||
|
write markdown file to args.output_dir in html,
|
||||||
|
return list of tuple of output filepath, frontmatter post
|
||||||
|
"""
|
||||||
|
with open(input_filepath, encoding='utf-8') as file_pointer:
|
||||||
|
content = frontmatter.load(file_pointer).content
|
||||||
|
|
||||||
|
properties = FILEMAP.get(input_filepath)
|
||||||
|
|
||||||
|
html = render_markdown(content)
|
||||||
|
html = JINJA_TEMPLATE_ARTICLE.render(
|
||||||
|
license=LICENSE,
|
||||||
|
content=html,
|
||||||
|
lecture_slides=properties.get("lecture_slides"),
|
||||||
|
lecture_notes=properties.get("lecture_notes"),
|
||||||
|
uuid=properties.get("uuid"),
|
||||||
|
tags=properties.get("tags"),
|
||||||
|
author=properties.get("author"),
|
||||||
|
title=properties.get("title"))
|
||||||
|
|
||||||
|
properties['dst_path']['html'].write_text(html)
|
||||||
|
|
||||||
|
|
||||||
|
def render_plaintext_file(input_filepath):
|
||||||
|
"""
|
||||||
|
render plaintext file to file
|
||||||
|
copy plaintext file into a html preview, copy raw to output dir
|
||||||
|
return list of tuple of output filepath, empty dict
|
||||||
|
"""
|
||||||
|
|
||||||
|
raw_content = input_filepath.read_text()
|
||||||
|
properties = FILEMAP.get(input_filepath)
|
||||||
|
html = JINJA_TEMPLATE_TEXTARTICLE.render(license=LICENSE, **properties)
|
||||||
|
properties['dst_path']['raw'].write_text(raw_content)
|
||||||
|
properties['dst_path']['html'].write_text(html)
|
||||||
|
|
||||||
|
|
||||||
|
def render_generic_file(input_filepath):
|
||||||
|
"""
|
||||||
|
render generic file to file
|
||||||
|
copy generic file into to output_dir
|
||||||
|
return list of tuple of output filepath, empty dict
|
||||||
|
"""
|
||||||
|
properties = FILEMAP.get(input_filepath)
|
||||||
|
output_filepath = properties['dst_path']['raw']
|
||||||
|
shutil.copyfile(input_filepath, output_filepath)
|
||||||
|
|
||||||
|
|
||||||
|
def render_file(input_filepath):
|
||||||
|
"""
|
||||||
|
render any file by detecting type and applying appropriate type
|
||||||
|
write input_filepath to correct file in args.output_dir in appropriate formats,
|
||||||
|
return list of tuples of output filepath, frontmatter post
|
||||||
|
"""
|
||||||
|
|
||||||
|
if input_filepath.suffix == '.md':
|
||||||
|
return render_markdown_file(input_filepath)
|
||||||
|
|
||||||
|
if FileMap.is_plaintext(input_filepath):
|
||||||
|
return render_plaintext_file(input_filepath)
|
||||||
|
|
||||||
|
return render_generic_file(input_filepath)
|
||||||
|
|
||||||
|
|
||||||
|
def render_markdown(content):
|
||||||
|
"""
|
||||||
|
render markdown to html
|
||||||
|
"""
|
||||||
|
|
||||||
|
post_body = {
|
||||||
|
'text': content,
|
||||||
|
'toc-depth': 6,
|
||||||
|
'highlight-style': 'pygments',
|
||||||
|
'html-math-method': 'mathml',
|
||||||
|
'to': 'html',
|
||||||
|
'files': {
|
||||||
|
'data/data/abbreviations': '',
|
||||||
|
},
|
||||||
|
'standalone': False,
|
||||||
|
}
|
||||||
|
|
||||||
|
headers = {'Accept': 'application/json'}
|
||||||
|
|
||||||
|
response = requests.post(PANDOC_SERVER_URL,
|
||||||
|
headers=headers,
|
||||||
|
json=post_body,
|
||||||
|
timeout=PANDOC_TIMEOUT)
|
||||||
|
|
||||||
|
response = response.json()
|
||||||
|
|
||||||
|
# TODO look at response['messages'] and log them maybe?
|
||||||
|
# https://github.com/jgm/pandoc/blob/main/doc/pandoc-server.md#response
|
||||||
|
|
||||||
|
return response['output']
|
||||||
|
|
||||||
|
|
||||||
|
def process_home_index(args, notes_git_head_sha1=None):
|
||||||
|
"""
|
||||||
|
create home index.html in output_dir
|
||||||
|
"""
|
||||||
|
|
||||||
|
post = {'title': 'gronk', 'content': ''}
|
||||||
|
custom_content_file = args.notes.joinpath('readme.md')
|
||||||
|
if custom_content_file.is_file():
|
||||||
|
fmpost = frontmatter.loads(custom_content_file.read_text()).to_dict()
|
||||||
|
for key, val in fmpost.items():
|
||||||
|
post[key] = val
|
||||||
|
|
||||||
|
post['content'] = render_markdown(post['content'])
|
||||||
|
|
||||||
|
html = JINJA_TEMPLATE_HOME_INDEX.render(
|
||||||
|
gronk_commit=GRONK_COMMIT,
|
||||||
|
search_data=FILEMAP.to_search_data(),
|
||||||
|
notes_git_head_sha1=notes_git_head_sha1,
|
||||||
|
post=post)
|
||||||
|
|
||||||
|
args.output_dir.joinpath('index.html').write_text(html)
|
||||||
|
|
||||||
|
|
||||||
|
def generate_permalink_page(output_dir):
|
||||||
|
"""
|
||||||
|
create the directory and index.html for redirecting permalinks
|
||||||
|
"""
|
||||||
|
|
||||||
|
dir = output_dir.joinpath('permalink')
|
||||||
|
dir.mkdir(exist_ok=True)
|
||||||
|
dir.joinpath('index.html').write_text(
|
||||||
|
JINJA_TEMPLATE_PERMALINK.render(gronk_commit=GRONK_COMMIT,
|
||||||
|
data=FILEMAP.get_uuid_map()))
|
||||||
|
|
||||||
|
|
||||||
|
def generate_tag_browser(output_dir):
|
||||||
|
"""
|
||||||
|
generate a directory that lets you groub by and browse by any given tag. e.g. tags, authors
|
||||||
|
"""
|
||||||
|
tags = {}
|
||||||
|
|
||||||
|
for post in FILEMAP.to_list():
|
||||||
|
post['path'] = post['dst_path']['web']
|
||||||
|
|
||||||
|
if 'tags' not in post.keys():
|
||||||
|
continue
|
||||||
|
|
||||||
|
for tag in post['tags']:
|
||||||
|
if tag not in tags.keys():
|
||||||
|
tags[tag] = []
|
||||||
|
|
||||||
|
tags[tag].append(post)
|
||||||
|
|
||||||
|
for tag, index_entries in tags.items():
|
||||||
|
output_file = output_dir.joinpath(tag, 'index.html')
|
||||||
|
output_file.parent.mkdir(exist_ok=True, parents=True)
|
||||||
|
output_file.write_text(
|
||||||
|
JINJA_TEMPLATE_INDEX.render(
|
||||||
|
gronk_commit=GRONK_COMMIT,
|
||||||
|
automatic_index=True,
|
||||||
|
search_bar=True,
|
||||||
|
title=tag,
|
||||||
|
index_entries=[{
|
||||||
|
'title': entry.get('title', ''),
|
||||||
|
'is_dir': entry.get('is_dir', False),
|
||||||
|
'path': str(entry.get('path', Path(''))),
|
||||||
|
} for entry in index_entries],
|
||||||
|
))
|
||||||
|
|
||||||
|
output_file = output_dir.joinpath('index.html')
|
||||||
|
output_file.parent.mkdir(exist_ok=True, parents=True)
|
||||||
|
output_file.write_text(
|
||||||
|
JINJA_TEMPLATE_INDEX.render(automatic_index=True,
|
||||||
|
gronk_commit=GRONK_COMMIT,
|
||||||
|
search_bar=True,
|
||||||
|
title='tags',
|
||||||
|
index_entries=[{
|
||||||
|
'path': tag,
|
||||||
|
'title': tag,
|
||||||
|
'is_dir': False,
|
||||||
|
} for tag in tags.keys()]))
|
||||||
|
|
||||||
|
|
||||||
|
def main(args):
|
||||||
|
""" Entry point for script """
|
||||||
|
|
||||||
|
start_time = time.time()
|
||||||
|
|
||||||
|
global LICENSE
|
||||||
|
global FILEMAP
|
||||||
|
|
||||||
|
FILEMAP = FileMap(args.notes, args.output_dir.joinpath('notes'))
|
||||||
|
|
||||||
|
# TODO have some sort of 'site rebuild in progress - come back in a minute
|
||||||
|
# or two!' or auto checking/refreshing page for when site is being built
|
||||||
|
|
||||||
|
if args.output_dir.is_file():
|
||||||
|
print(f"Output directory ({args.output_dir}) cannot be a file.")
|
||||||
|
|
||||||
|
args.output_dir.mkdir(parents=True, exist_ok=True)
|
||||||
|
|
||||||
|
# attempt to get licensing information
|
||||||
|
license_path = args.notes.joinpath("LICENSE")
|
||||||
|
if license_path.exists():
|
||||||
|
LICENSE = license_path.read_text()
|
||||||
|
|
||||||
|
# TODO git commit log integration
|
||||||
|
|
||||||
|
for root_str, _, files in os.walk(args.notes):
|
||||||
|
root = Path(root_str)
|
||||||
|
if '.git' in root.parts:
|
||||||
|
continue
|
||||||
|
|
||||||
|
root_properties = FILEMAP.get(root)
|
||||||
|
root_properties['dst_path']['raw'].mkdir(parents=True, exist_ok=True)
|
||||||
|
|
||||||
|
#pprint.pprint(root_properties)
|
||||||
|
html = JINJA_TEMPLATE_INDEX.render(
|
||||||
|
gronk_commit=GRONK_COMMIT,
|
||||||
|
title=root_properties.get('title', ''),
|
||||||
|
content=root_properties.get('content', ''),
|
||||||
|
content_after_search=root_properties['content_after_search'],
|
||||||
|
automatic_index=root_properties['automatic_index'],
|
||||||
|
search_bar=root_properties['search_bar'],
|
||||||
|
index_entries=[{
|
||||||
|
'title': entry.get('title', ''),
|
||||||
|
'is_dir': entry.get('is_dir', False),
|
||||||
|
'path': str(entry.get('path', Path(''))),
|
||||||
|
} for entry in root_properties.get('index_entries', '')],
|
||||||
|
)
|
||||||
|
root_properties['dst_path']['raw'].joinpath('index.html').write_text(
|
||||||
|
html)
|
||||||
|
|
||||||
|
# render each file
|
||||||
|
for file in files:
|
||||||
|
# don't render readme.md as index as it is used for directory
|
||||||
|
if file == "readme.md":
|
||||||
|
continue
|
||||||
|
render_file(root.joinpath(file))
|
||||||
|
|
||||||
|
process_home_index(args)
|
||||||
|
|
||||||
|
# copy styling and js scripts necessary for function
|
||||||
|
shutil.copytree(GRONK_CSS_DIR,
|
||||||
|
args.output_dir.joinpath('css'),
|
||||||
|
dirs_exist_ok=True)
|
||||||
|
shutil.copytree(GRONK_JS_DIR,
|
||||||
|
args.output_dir.joinpath('js'),
|
||||||
|
dirs_exist_ok=True)
|
||||||
|
|
||||||
|
generate_tag_browser(args.output_dir.joinpath('tags'))
|
||||||
|
generate_permalink_page(args.output_dir)
|
||||||
|
|
||||||
|
elapsed_time = time.time() - start_time
|
||||||
|
print(f"generated notes {elapsed_time=}")
|
||||||
|
|
||||||
|
return 0
|
||||||
|
|
||||||
|
|
||||||
|
def start_pandoc_server():
|
||||||
|
"""
|
||||||
|
attempt to get the version of pandoc server in a loop until it is
|
||||||
|
successful and return version as string
|
||||||
|
"""
|
||||||
|
start_time = time.time()
|
||||||
|
process = subprocess.Popen(["/usr/bin/pandoc-server"],
|
||||||
|
stdout=subprocess.PIPE)
|
||||||
|
version = None
|
||||||
|
|
||||||
|
while True:
|
||||||
|
try:
|
||||||
|
resp = requests.get(f"{PANDOC_SERVER_URL}/version")
|
||||||
|
version = resp.content.decode('utf-8')
|
||||||
|
break
|
||||||
|
except requests.ConnectionError:
|
||||||
|
time.sleep(0.1)
|
||||||
|
rc = process.poll()
|
||||||
|
if rc is not None:
|
||||||
|
print(f"PANDOC SERVER FAILED TO START: {rc=}")
|
||||||
|
print(process.stdout.read().decode("utf-8"))
|
||||||
|
raise Exception("Pandoc server failed to start")
|
||||||
|
|
||||||
|
elapsed_time = time.time() - start_time
|
||||||
|
print(f"pandoc-server started {version=} {elapsed_time=}")
|
||||||
|
return process
|
||||||
|
|
||||||
|
|
||||||
|
# TODO implement useful logging and debug printing
|
||||||
|
|
||||||
|
if __name__ == '__main__':
|
||||||
|
pandoc_process = start_pandoc_server()
|
||||||
|
|
||||||
|
try:
|
||||||
|
sys.exit(main(get_args()))
|
||||||
|
except KeyboardInterrupt:
|
||||||
|
sys.exit(0)
|
||||||
|
finally:
|
||||||
|
pandoc_process.kill()
|
57
gronk_add_uuid.py
Normal file
57
gronk_add_uuid.py
Normal file
@@ -0,0 +1,57 @@
|
|||||||
|
#!/usr/bin/env python3
|
||||||
|
|
||||||
|
import pathlib
|
||||||
|
import sys
|
||||||
|
import uuid
|
||||||
|
|
||||||
|
import editfrontmatter
|
||||||
|
import frontmatter
|
||||||
|
|
||||||
|
|
||||||
|
def get_args():
|
||||||
|
""" Get command line arguments """
|
||||||
|
|
||||||
|
import argparse
|
||||||
|
parser = argparse.ArgumentParser()
|
||||||
|
parser.add_argument('filename', type=pathlib.Path)
|
||||||
|
parser.add_argument('-w',
|
||||||
|
'--write',
|
||||||
|
action='store_true',
|
||||||
|
help='write to file instead of stdout')
|
||||||
|
return parser.parse_args()
|
||||||
|
|
||||||
|
|
||||||
|
def main(args):
|
||||||
|
""" Entry point for script """
|
||||||
|
template_str = "\n".join([
|
||||||
|
"author: {{ author }}"
|
||||||
|
"date: {{ date }}"
|
||||||
|
"title: {{ title }}"
|
||||||
|
"tags: {{ tags }}"
|
||||||
|
"uuid: {{ uuid }}"
|
||||||
|
])
|
||||||
|
|
||||||
|
with open(args.filename) as fp:
|
||||||
|
fm_pre = frontmatter.load(fp)
|
||||||
|
|
||||||
|
processor = editfrontmatter.EditFrontMatter(file_path=args.filename,
|
||||||
|
template_str=template_str)
|
||||||
|
fm_data = fm_pre.metadata
|
||||||
|
if 'uuid' not in fm_data.keys():
|
||||||
|
fm_data['uuid'] = str(uuid.uuid4())
|
||||||
|
|
||||||
|
processor.run(fm_data)
|
||||||
|
|
||||||
|
if args.write:
|
||||||
|
with open(args.filename, 'w') as fp:
|
||||||
|
fp.write(processor.dumpFileData())
|
||||||
|
else:
|
||||||
|
print(processor.dumpFileData())
|
||||||
|
return 0
|
||||||
|
|
||||||
|
|
||||||
|
if __name__ == '__main__':
|
||||||
|
try:
|
||||||
|
sys.exit(main(get_args()))
|
||||||
|
except KeyboardInterrupt:
|
||||||
|
sys.exit(0)
|
2255
js/fuse.js
Normal file
2255
js/fuse.js
Normal file
File diff suppressed because it is too large
Load Diff
75
js/indexsearch.js
Normal file
75
js/indexsearch.js
Normal file
@@ -0,0 +1,75 @@
|
|||||||
|
const HEADERS = "headers"
|
||||||
|
const PATH = "path"
|
||||||
|
const TAGS = "tags"
|
||||||
|
const TITLE = "title"
|
||||||
|
|
||||||
|
const SEARCH_TIMEOUT_MS = 100
|
||||||
|
var SEARCH_TIMEOUT_ID = -1
|
||||||
|
|
||||||
|
const fuse = new Fuse(data, {
|
||||||
|
keys: [ 'title' ],
|
||||||
|
ignoreLocation: true,
|
||||||
|
threshhold: 0.4,
|
||||||
|
minMatchCharLength: 0,
|
||||||
|
})
|
||||||
|
|
||||||
|
const RESULTS_MAX = 15
|
||||||
|
|
||||||
|
const searchBar = document.getElementById('search')
|
||||||
|
const resultsDiv = document.getElementById('searchResults')
|
||||||
|
|
||||||
|
var results = []
|
||||||
|
|
||||||
|
function updateResultsWithTimeout() {
|
||||||
|
console.log("clearing timeout")
|
||||||
|
if (SEARCH_TIMEOUT_ID) SEARCH_TIMEOUT_ID = clearTimeout(SEARCH_TIMEOUT_ID)
|
||||||
|
SEARCH_TIMEOUT_ID = setTimeout(updateResults, SEARCH_TIMEOUT_MS)
|
||||||
|
}
|
||||||
|
|
||||||
|
function updateResults() {
|
||||||
|
console.log("updating results")
|
||||||
|
resultsDiv.innerHTML = ''
|
||||||
|
if (searchBar.value) results = fuse.search(searchBar.value, { limit: RESULTS_MAX }).map(r => r.item)
|
||||||
|
else results = data
|
||||||
|
|
||||||
|
results.forEach(r => {
|
||||||
|
wrapper = document.createElement('li')
|
||||||
|
wrapper.className = "article"
|
||||||
|
|
||||||
|
atag = document.createElement('a')
|
||||||
|
atag.href = r.path
|
||||||
|
|
||||||
|
ptag = document.createElement('p')
|
||||||
|
ptag.innerHTML = r.title + (r.isdirectory ? '/' : '')
|
||||||
|
|
||||||
|
atag.appendChild(ptag)
|
||||||
|
wrapper.appendChild(atag)
|
||||||
|
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].path, '_blank')
|
||||||
|
} else {
|
||||||
|
window.location.href = results[0].path
|
||||||
|
}
|
||||||
|
return
|
||||||
|
}
|
||||||
|
updateResultsWithTimeout()
|
||||||
|
})
|
||||||
|
|
||||||
|
searchBar.addEventListener('change', updateResultsWithTimeout)
|
||||||
|
|
||||||
|
const searchParams = new URL(window.location.href).searchParams;
|
||||||
|
searchBar.value = searchParams.get('q');
|
||||||
|
updateResults();
|
||||||
|
|
||||||
|
console.log(results)
|
||||||
|
|
||||||
|
if (searchParams.has('lucky')) {
|
||||||
|
window.location.href = results[0].path;
|
||||||
|
}
|
8
js/permalink.js
Normal file
8
js/permalink.js
Normal file
@@ -0,0 +1,8 @@
|
|||||||
|
'use strict';
|
||||||
|
|
||||||
|
const MANUAL_REDIRECT = document.getElementById('manual_redirect');
|
||||||
|
|
||||||
|
const newLocation = data[new URLSearchParams(window.location.search).get('uuid')];
|
||||||
|
|
||||||
|
MANUAL_REDIRECT.href = newLocation;
|
||||||
|
window.location = newLocation;
|
135
js/search.js
Normal file
135
js/search.js
Normal file
@@ -0,0 +1,135 @@
|
|||||||
|
/*
|
||||||
|
* search.js expects an array `data` containing objects with the following keys:
|
||||||
|
* headers: [string]
|
||||||
|
* path: string
|
||||||
|
* tags: [string]
|
||||||
|
* title: string
|
||||||
|
* uuid: string
|
||||||
|
*/
|
||||||
|
|
||||||
|
|
||||||
|
const HEADERS = "headers"
|
||||||
|
const PATH = "path"
|
||||||
|
const TAGS = "tags"
|
||||||
|
const TITLE = "title"
|
||||||
|
|
||||||
|
const SEARCH_TIMEOUT_MS = 100
|
||||||
|
var SEARCH_TIMEOUT_ID = -1
|
||||||
|
|
||||||
|
const fuse = new Fuse(search_data, {
|
||||||
|
keys: [
|
||||||
|
{
|
||||||
|
name: HEADERS,
|
||||||
|
weight: 1
|
||||||
|
},
|
||||||
|
{
|
||||||
|
name: PATH,
|
||||||
|
weight: 0.1
|
||||||
|
},
|
||||||
|
{
|
||||||
|
name: TAGS,
|
||||||
|
weight: 0.5
|
||||||
|
},
|
||||||
|
{
|
||||||
|
name: TITLE,
|
||||||
|
weight: 2
|
||||||
|
}
|
||||||
|
],
|
||||||
|
includeMatches: true,
|
||||||
|
useExtendedSearch: true,
|
||||||
|
ignoreLocation: true,
|
||||||
|
threshhold: 0.4,
|
||||||
|
})
|
||||||
|
|
||||||
|
const RESULTS_MAX = 5
|
||||||
|
|
||||||
|
const searchBar = document.getElementById('search')
|
||||||
|
const resultsDiv = document.getElementById('results')
|
||||||
|
|
||||||
|
var results = []
|
||||||
|
|
||||||
|
function updateResultsWithTimeout() {
|
||||||
|
console.log("clearing timeout")
|
||||||
|
if (SEARCH_TIMEOUT_ID) SEARCH_TIMEOUT_ID = clearTimeout(SEARCH_TIMEOUT_ID)
|
||||||
|
SEARCH_TIMEOUT_ID = setTimeout(updateResults, SEARCH_TIMEOUT_MS)
|
||||||
|
}
|
||||||
|
|
||||||
|
function updateResults() {
|
||||||
|
console.log("updating results")
|
||||||
|
resultsDiv.innerHTML = ''
|
||||||
|
results = fuse.search(searchBar.value, { limit: RESULTS_MAX })
|
||||||
|
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
|
||||||
|
}
|
||||||
|
updateResultsWithTimeout()
|
||||||
|
})
|
||||||
|
|
||||||
|
searchBar.addEventListener('change', updateResultsWithTimeout)
|
||||||
|
|
||||||
|
const searchParams = new URL(window.location.href).searchParams;
|
||||||
|
searchBar.value = searchParams.get('q');
|
||||||
|
updateResults();
|
||||||
|
|
||||||
|
console.log(results)
|
||||||
|
|
||||||
|
if (searchParams.has('lucky')) {
|
||||||
|
window.location.href = results[0].item.path;
|
||||||
|
}
|
94
js/toc_search.js
Normal file
94
js/toc_search.js
Normal file
@@ -0,0 +1,94 @@
|
|||||||
|
'use strict';
|
||||||
|
|
||||||
|
var raw_html_tree = document.getElementById('toc').firstChild.cloneNode(true);
|
||||||
|
|
||||||
|
function createSearchable(el) {
|
||||||
|
var par = el.parentElement;
|
||||||
|
var obj = el.cloneNode(true);
|
||||||
|
|
||||||
|
while(par != raw_html_tree) {
|
||||||
|
var clone_parent = par.cloneNode(true);
|
||||||
|
|
||||||
|
while (clone_parent.firstChild != clone_parent.lastChild) {
|
||||||
|
clone_parent.removeChild(clone_parent.lastChild);
|
||||||
|
}
|
||||||
|
console.log("obj.innerHTML: " + obj.innerHTML);
|
||||||
|
console.log("clone_parent.firstChild.innerHTML: " + clone_parent.firstChild.innerHTML);
|
||||||
|
if (obj.innerHTML != clone_parent.firstChild.innerHTML)
|
||||||
|
clone_parent.appendChild(obj);
|
||||||
|
|
||||||
|
obj = clone_parent;
|
||||||
|
par = par.parentElement;
|
||||||
|
}
|
||||||
|
|
||||||
|
return {
|
||||||
|
searchable: el.innerHTML,
|
||||||
|
obj: obj
|
||||||
|
};
|
||||||
|
}
|
||||||
|
|
||||||
|
var searchables = [];
|
||||||
|
Array(...raw_html_tree.getElementsByTagName('a'))
|
||||||
|
.forEach(el => searchables.push(createSearchable(el)));
|
||||||
|
|
||||||
|
var fuse = new Fuse(searchables, { keys: [ 'searchable' ], includeMatches: true});
|
||||||
|
var searchBar = document.getElementById('search');
|
||||||
|
var resultsDiv = document.getElementById('toc');
|
||||||
|
|
||||||
|
function updateResults() {
|
||||||
|
var ul = document.createElement('ul');
|
||||||
|
resultsDiv.innerHTML = '';
|
||||||
|
if (searchBar.value == '') {
|
||||||
|
resultsDiv.appendChild(raw_html_tree);
|
||||||
|
return;
|
||||||
|
}
|
||||||
|
var results = fuse.search(searchBar.value);
|
||||||
|
|
||||||
|
|
||||||
|
results.forEach(r => {
|
||||||
|
console.log(r)
|
||||||
|
var content = r.item.obj
|
||||||
|
var last_a = Array.from(r.item.obj.getElementsByTagName('a')).pop()
|
||||||
|
|
||||||
|
r.matches.reverse().every(match => {
|
||||||
|
var display_match = match.value;
|
||||||
|
if (match.indices.length >= 1) {
|
||||||
|
match.indices.sort((a, b) => (b[1]-b[0])-(a[1]-a[0]));
|
||||||
|
const indexPair = match.indices[0];
|
||||||
|
const matching_slice = match.value.slice(indexPair[0], indexPair[1]+1);
|
||||||
|
last_a.innerHTML = match.value.replace(
|
||||||
|
matching_slice,
|
||||||
|
'<span class="matchHighlight">' + matching_slice + '</span>'
|
||||||
|
);
|
||||||
|
}
|
||||||
|
return true;
|
||||||
|
})
|
||||||
|
|
||||||
|
ul.appendChild(content);
|
||||||
|
ul.appendChild(document.createElement('br'));
|
||||||
|
})
|
||||||
|
resultsDiv.appendChild(ul);
|
||||||
|
}
|
||||||
|
|
||||||
|
searchBar.addEventListener('keyup', 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);
|
||||||
|
|
||||||
|
const searchParams = new URL(window.location.href).searchParams;
|
||||||
|
searchBar.value = searchParams.get('q');
|
||||||
|
updateResults();
|
||||||
|
|
||||||
|
if (searchParams.has('lucky')) {
|
||||||
|
window.location.href = results[0].item.path;
|
||||||
|
}
|
181
notes2web.py
181
notes2web.py
@@ -1,181 +0,0 @@
|
|||||||
#!/usr/bin/env python3
|
|
||||||
|
|
||||||
|
|
||||||
from bs4 import BeautifulSoup as bs
|
|
||||||
import magic
|
|
||||||
import sys
|
|
||||||
import pathlib
|
|
||||||
import pypandoc
|
|
||||||
import shutil
|
|
||||||
import os
|
|
||||||
import re
|
|
||||||
|
|
||||||
TEXT_ARTICLE_TEMPLATE_FOOT = None
|
|
||||||
TEXT_ARTICLE_TEMPLATE_HEAD = None
|
|
||||||
INDEX_TEMPLATE_FOOT = None
|
|
||||||
INDEX_TEMPLATE_HEAD = None
|
|
||||||
EXTRA_INDEX_CONTENT = None
|
|
||||||
|
|
||||||
def get_files(folder):
|
|
||||||
markdown = []
|
|
||||||
plaintext = []
|
|
||||||
other = []
|
|
||||||
|
|
||||||
for root, folders, files in os.walk(folder):
|
|
||||||
for filename in files:
|
|
||||||
name = os.path.join(root, filename)
|
|
||||||
if os.path.splitext(name)[1] == '.md':
|
|
||||||
markdown.append(name)
|
|
||||||
elif re.match(r'^text/', magic.from_file(name, mime=True)):
|
|
||||||
plaintext.append(name)
|
|
||||||
other.append(name)
|
|
||||||
else:
|
|
||||||
other.append(name)
|
|
||||||
|
|
||||||
return markdown, plaintext, other
|
|
||||||
|
|
||||||
def get_dirs(folder):
|
|
||||||
r = []
|
|
||||||
|
|
||||||
for root, folders, files in os.walk(folder):
|
|
||||||
[r.append(os.path.join(root, folder)) for folder in folders]
|
|
||||||
|
|
||||||
return r
|
|
||||||
|
|
||||||
|
|
||||||
def get_args():
|
|
||||||
""" Get command line arguments """
|
|
||||||
|
|
||||||
import argparse
|
|
||||||
parser = argparse.ArgumentParser()
|
|
||||||
parser.add_argument('notes', type=pathlib.Path)
|
|
||||||
parser.add_argument('-o', '--output-dir', type=pathlib.Path, default='web')
|
|
||||||
parser.add_argument('-t', '--template', type=pathlib.Path, default=pathlib.Path('/opt/notes2web/templates/article.html'))
|
|
||||||
parser.add_argument('-H', '--template-text-head', type=pathlib.Path, default=pathlib.Path('/opt/notes2web/templates/textarticlehead.html'))
|
|
||||||
parser.add_argument('-f', '--template-text-foot', type=pathlib.Path, default=pathlib.Path('/opt/notes2web/templates/textarticlefoot.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('-s', '--stylesheet', type=pathlib.Path, default=pathlib.Path('/opt/notes2web/styles.css'))
|
|
||||||
parser.add_argument('-e', '--extra-index-content', type=pathlib.Path, default=pathlib.Path('/opt/notes2web/templates/extra_index_content.html'))
|
|
||||||
return parser.parse_args()
|
|
||||||
|
|
||||||
|
|
||||||
def main(args):
|
|
||||||
""" Entry point for script """
|
|
||||||
|
|
||||||
with open(args.template_text_foot) as fp:
|
|
||||||
TEXT_ARTICLE_TEMPLATE_FOOT = fp.read()
|
|
||||||
|
|
||||||
with open(args.template_text_head) as fp:
|
|
||||||
TEXT_ARTICLE_TEMPLATE_HEAD = fp.read()
|
|
||||||
|
|
||||||
with open(args.template_index_foot) as fp:
|
|
||||||
INDEX_TEMPLATE_FOOT = fp.read()
|
|
||||||
|
|
||||||
with open(args.template_index_head) as fp:
|
|
||||||
INDEX_TEMPLATE_HEAD = fp.read()
|
|
||||||
|
|
||||||
with open(args.extra_index_content) as fp:
|
|
||||||
EXTRA_INDEX_CONTENT = fp.read()
|
|
||||||
|
|
||||||
if not os.path.exists(args.output_dir):
|
|
||||||
os.makedirs(args.output_dir, exist_ok=True)
|
|
||||||
|
|
||||||
if os.path.isfile(args.output_dir):
|
|
||||||
print("Output directory ({output_dir}) cannot be a file.")
|
|
||||||
|
|
||||||
|
|
||||||
markdown_files, plaintext_files, other_files = get_files(args.notes)
|
|
||||||
|
|
||||||
print(f"{markdown_files=}")
|
|
||||||
for filename in markdown_files:
|
|
||||||
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:
|
|
||||||
fp.write(html)
|
|
||||||
|
|
||||||
print(f"{plaintext_files=}")
|
|
||||||
for filename in plaintext_files:
|
|
||||||
output_filename = re.sub(f"^{args.notes.name}", args.output_dir.name, filename) + '.html'
|
|
||||||
os.makedirs(os.path.dirname(output_filename), exist_ok=True)
|
|
||||||
title = os.path.basename(output_filename)
|
|
||||||
html = re.sub(r'\$title\$', title, TEXT_ARTICLE_TEMPLATE_HEAD)
|
|
||||||
html = re.sub(r'\$raw\$', os.path.basename(filename), html)
|
|
||||||
with open(filename) as fp:
|
|
||||||
html += fp.read()
|
|
||||||
html += TEXT_ARTICLE_TEMPLATE_FOOT
|
|
||||||
|
|
||||||
with open(output_filename, 'w+') as fp:
|
|
||||||
fp.write(html)
|
|
||||||
|
|
||||||
print(f"{other_files=}")
|
|
||||||
for filename in other_files:
|
|
||||||
output_filename = re.sub(f"^{args.notes.name}", args.output_dir.name, filename)
|
|
||||||
os.makedirs(os.path.dirname(output_filename), exist_ok=True)
|
|
||||||
shutil.copyfile(filename, output_filename)
|
|
||||||
|
|
||||||
|
|
||||||
dirs_to_index = [args.output_dir.name] + get_dirs(args.output_dir)
|
|
||||||
print(f"{dirs_to_index=}")
|
|
||||||
print(f"{os.path.commonpath(dirs_to_index)=}")
|
|
||||||
|
|
||||||
for directory in dirs_to_index:
|
|
||||||
paths = os.listdir(directory)
|
|
||||||
print(f"{paths=}")
|
|
||||||
|
|
||||||
indexentries = []
|
|
||||||
|
|
||||||
for path in paths:
|
|
||||||
if path == 'index.html':
|
|
||||||
continue
|
|
||||||
|
|
||||||
fullpath = os.path.join(directory, path)
|
|
||||||
if os.path.splitext(path)[1] == '.html':
|
|
||||||
with open(fullpath) as fp:
|
|
||||||
soup = bs(fp.read(), 'html.parser')
|
|
||||||
|
|
||||||
try:
|
|
||||||
title = soup.find('title').get_text()
|
|
||||||
except AttributeError:
|
|
||||||
title = path
|
|
||||||
else:
|
|
||||||
title = path
|
|
||||||
|
|
||||||
if title.strip() == '':
|
|
||||||
title = path
|
|
||||||
|
|
||||||
indexentries.append({
|
|
||||||
'title': title,
|
|
||||||
'path': path,
|
|
||||||
'isdirectory': os.path.isdir(fullpath)
|
|
||||||
})
|
|
||||||
|
|
||||||
indexentries.sort(key=lambda entry: entry['title'])
|
|
||||||
indexentries.sort(key=lambda entry: entry['isdirectory'], reverse=True)
|
|
||||||
|
|
||||||
html = re.sub(r'\$title\$', directory, INDEX_TEMPLATE_HEAD)
|
|
||||||
html = re.sub(r'\$extra_content\$',
|
|
||||||
EXTRA_INDEX_CONTENT if directory == os.path.commonpath(dirs_to_index) else '',
|
|
||||||
html
|
|
||||||
)
|
|
||||||
|
|
||||||
for entry in indexentries:
|
|
||||||
html += f"<div class=\"article\"><a href=\"{entry['path']}\">{entry['title']}{'/' if entry['isdirectory'] else ''}</a></div>"
|
|
||||||
html += INDEX_TEMPLATE_FOOT
|
|
||||||
|
|
||||||
with open(os.path.join(directory, 'index.html'), 'w+') as fp:
|
|
||||||
fp.write(html)
|
|
||||||
|
|
||||||
shutil.copyfile(args.stylesheet, os.path.join(args.output_dir.name, 'styles.css'))
|
|
||||||
|
|
||||||
return 0
|
|
||||||
|
|
||||||
|
|
||||||
if __name__ == '__main__':
|
|
||||||
try:
|
|
||||||
sys.exit(main(get_args()))
|
|
||||||
except KeyboardInterrupt:
|
|
||||||
sys.exit(0)
|
|
146
readme.md
146
readme.md
@@ -1,48 +1,136 @@
|
|||||||
# notes2web
|
# gronk
|
||||||
|
|
||||||
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).
|
||||||
|
|
||||||

|

|
||||||
|
|
||||||
|
Tested with [pandoc v2.19.2](https://github.com/jgm/pandoc/releases/tag/2.19.2).
|
||||||
|
|
||||||
|
|
||||||
|
## Why?
|
||||||
|
|
||||||
|
- View notes as a website, on any device
|
||||||
|
- Easily share notes
|
||||||
|
- Powered by Pandoc, and therefore supports [Pandoc's markdown](https://pandoc.org/MANUAL.html#pandocs-markdown) (I mainly care about equations)
|
||||||
|
- [flatnotes](https://github.com/Dullage/flatnotes) is cool but I really would rather type my notes in Vim
|
||||||
|
- Lightweight HTML generated
|
||||||
|
- Minimal JavaScript
|
||||||
|
|
||||||
|
|
||||||
## Install
|
## Install
|
||||||
|
|
||||||
0. Install [Pandoc](https://pandoc.org/index.html) and [yq](https://github.com/mikefarah/yq)
|
### Docker
|
||||||
|
|
||||||
On arch:
|
Run the following, modifing the `-v` arguments as needed to mount the correct folders and
|
||||||
```
|
setting the value of `ARCH` to either `amd64` or `arm64` as appropriate.
|
||||||
# pacman -S pandoc yq
|
|
||||||
```
|
|
||||||
|
|
||||||
1. Run `make install` as root
|
|
||||||
|
|
||||||
## Usage
|
|
||||||
|
|
||||||
```
|
```
|
||||||
$ notes2web.py NOTES_DIRECTORY_1
|
docker build . -t gronk --build-arg ARCH=amd64
|
||||||
|
docker run -v ./n:/usr/src/app/notes -v ./web:/usr/src/app/web gronk
|
||||||
```
|
```
|
||||||
|
|
||||||
Output of `notes2web.py --help`:
|
#### Compose
|
||||||
|
|
||||||
|
A [docker compose file](./docker-compose.yml) file has been provided.
|
||||||
|
|
||||||
|
Set the following environment variables (or create a .env file) and run `docker compose up`:
|
||||||
|
|
||||||
|
- `ARCH`
|
||||||
|
- `SOURCE`
|
||||||
|
- `OUTPUT`
|
||||||
|
|
||||||
|
### Locally
|
||||||
|
|
||||||
|
0. Install [Pandoc](https://pandoc.org/index.html) and [Pip](https://github.com/pypa/pip), python3-dev, and a C compiler
|
||||||
|
1. `sudo make install`
|
||||||
|
|
||||||
|
## Other Things to Know
|
||||||
|
|
||||||
|
- gronk indexes [ATX-style headings](https://pandoc.org/MANUAL.html#atx-style-headings) for
|
||||||
|
searching
|
||||||
|
- gronk looks for the plaintext file `LICENSE` in the root directory of your notes
|
||||||
|
|
||||||
|
|
||||||
|
## Custom Directory Index and Metadata
|
||||||
|
|
||||||
|
To add custom content to a directory index, put it in a file called `readme.md` under the directory.
|
||||||
|
|
||||||
|
You can set the following frontmatter variables to customise the directory index of a directory:
|
||||||
|
|
||||||
|
| variable | default value | description |
|
||||||
|
|------------------------|-------------------|--------------------------------------------------------------------------------------------|
|
||||||
|
| `tags` | `[]` | list of tags, used by search and inherited by any notes and subdirectories |
|
||||||
|
| `uuid` | none | unique id to reference directory, used for permalinking |
|
||||||
|
| `content_after_search` | `false` | show custom content in `readme.md` after search bar and directory index |
|
||||||
|
| `automatic_index` | `true` | show the automatically generated directory index. required for search bar to function. |
|
||||||
|
| `search_bar` | `true` | show search bar to search directory items. requires `automatic_index` (enabled by default) |
|
||||||
|
|
||||||
|
|
||||||
|
## Notes Metadata
|
||||||
|
|
||||||
|
gronk reads the following YAML [frontmatter](https://jekyllrb.com/docs/front-matter/) variables for metadata:
|
||||||
|
|
||||||
|
| variable | description |
|
||||||
|
|------------------|---------------------------------------------------------------------------------------|
|
||||||
|
| `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 |
|
||||||
|
| `title` | The title of the article |
|
||||||
|
| `uuid` | A unique identifier used for permalinks. |
|
||||||
|
| `lecture_slides` | a list of paths pointing to lecture slides used while taking notes |
|
||||||
|
| `lecture_notes` | a list of paths pointing to other notes used while taking notes |
|
||||||
|
|
||||||
|
## Permalinks
|
||||||
|
|
||||||
|
Permalinks are currently rather basic and requires JavaScript to be enabled on the local computer.
|
||||||
|
In order to identify documents between file changes, a unique identifier is used to identify a file.
|
||||||
|
|
||||||
|
This unique identifier can be generated using the `uuidgen` command in the `uuid-runtime` package or
|
||||||
|
`str(uuid.uuid())` in the `uuid` python package.
|
||||||
|
|
||||||
|
The included `n2w_add_uuid.py` will add a UUID to a markdown file which does not have a UUID in it
|
||||||
|
already.
|
||||||
|
Combine it with `find` to UUIDify all your markdown files (but make a backup first).
|
||||||
|
|
||||||
|
## Custom Styling
|
||||||
|
|
||||||
|
To completely replace the existing styling, set the environment variable `GRONK_CSS_DIR` to another directory with
|
||||||
|
a file called `styles.css`.
|
||||||
|
|
||||||
|
To add additional styling, the default styling will attempt to import `styles.css` from the root of the notes
|
||||||
|
directory.
|
||||||
|
|
||||||
|
To add additional content to the homepage, create a file called `readme.md` at the top level of your notes directory.
|
||||||
|
To set the HTML `title` tag, set `title` in the frontmatter of `readme.md`:
|
||||||
|
|
||||||
|
```markdown
|
||||||
|
---
|
||||||
|
title: "alv's notes"
|
||||||
|
---
|
||||||
|
|
||||||
|
# alv's notes
|
||||||
|
|
||||||
|
these notes are probably wrong
|
||||||
|
```
|
||||||
|
|
||||||
|
## CLI Usage
|
||||||
|
|
||||||
```
|
```
|
||||||
usage: notes2web.py [-h] [-o OUTPUT_DIR] [-t TEMPLATE] [-H TEMPLATE_TEXT_HEAD]
|
$ gronk.py notes_directory
|
||||||
[-f TEMPLATE_TEXT_FOOT] [-i TEMPLATE_INDEX_HEAD]
|
```
|
||||||
[-I TEMPLATE_INDEX_FOOT] [-s STYLESHEET]
|
|
||||||
[-e EXTRA_INDEX_CONTENT]
|
Output of `gronk.py --help`:
|
||||||
notes
|
|
||||||
|
```
|
||||||
|
usage: gronk.py [-h] [-o OUTPUT_DIR] [-F] notes
|
||||||
|
|
||||||
positional arguments:
|
positional arguments:
|
||||||
notes
|
notes
|
||||||
|
|
||||||
optional arguments:
|
options:
|
||||||
-h, --help show this help message and exit
|
-h, --help show this help message and exit
|
||||||
-o OUTPUT_DIR, --output-dir OUTPUT_DIR
|
-o OUTPUT_DIR, --output-dir OUTPUT_DIR
|
||||||
-t TEMPLATE, --template TEMPLATE
|
-F, --force Generate new output html even if source file was modified before output
|
||||||
-H TEMPLATE_TEXT_HEAD, --template-text-head TEMPLATE_TEXT_HEAD
|
html
|
||||||
-f TEMPLATE_TEXT_FOOT, --template-text-foot TEMPLATE_TEXT_FOOT
|
|
||||||
-i TEMPLATE_INDEX_HEAD, --template-index-head TEMPLATE_INDEX_HEAD
|
|
||||||
-I TEMPLATE_INDEX_FOOT, --template-index-foot TEMPLATE_INDEX_FOOT
|
|
||||||
-s STYLESHEET, --stylesheet STYLESHEET
|
|
||||||
-e EXTRA_INDEX_CONTENT, --extra-index-content EXTRA_INDEX_CONTENT
|
|
||||||
```
|
```
|
||||||
|
|
||||||
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).
|
||||||
@@ -55,3 +143,9 @@ Then you just have to point a webserver at `output-dir`.
|
|||||||
```
|
```
|
||||||
# make uninstall
|
# make uninstall
|
||||||
```
|
```
|
||||||
|
|
||||||
|
## Acknowledgements
|
||||||
|
|
||||||
|
Default synatx highlighting is based off [Pygments](https://pygments.org/)' default theme and
|
||||||
|
made using Pandoc v2.7.2.
|
||||||
|
I found the theme [here](https://github.com/tajmone/pandoc-goodies/blob/master/skylighting/css/built-in-styles/pygments.css).
|
||||||
|
14
requirements-dev.txt
Normal file
14
requirements-dev.txt
Normal file
@@ -0,0 +1,14 @@
|
|||||||
|
beautifulsoup4==4.9.3
|
||||||
|
editfrontmatter==0.0.1
|
||||||
|
greenlet==2.0.2
|
||||||
|
Jinja2==3.0.3
|
||||||
|
MarkupSafe==2.1.0
|
||||||
|
msgpack==1.0.5
|
||||||
|
oyaml==1.0
|
||||||
|
pynvim==0.4.3
|
||||||
|
pypandoc==1.5
|
||||||
|
python-frontmatter==1.0.0
|
||||||
|
python-magic==0.4.24
|
||||||
|
regex==2021.11.10
|
||||||
|
soupsieve==2.2.1
|
||||||
|
PyYAML==6.0.1
|
@@ -1,3 +1,21 @@
|
|||||||
beautifulsoup4==4.9.3
|
beautifulsoup4==4.9.3
|
||||||
|
certifi==2023.7.22
|
||||||
|
charset-normalizer==3.2.0
|
||||||
|
editfrontmatter==0.0.1
|
||||||
|
gitdb==4.0.10
|
||||||
|
GitPython==3.1.36
|
||||||
|
idna==3.4
|
||||||
|
Jinja2==3.0.3
|
||||||
|
MarkupSafe==2.1.0
|
||||||
|
oyaml==1.0
|
||||||
pypandoc==1.5
|
pypandoc==1.5
|
||||||
|
python-frontmatter==1.0.0
|
||||||
|
python-magic==0.4.24
|
||||||
|
PyYAML==5.3.1
|
||||||
|
regex==2021.11.10
|
||||||
soupsieve==2.2.1
|
soupsieve==2.2.1
|
||||||
|
regex==2021.11.10
|
||||||
|
requests==2.31.0
|
||||||
|
smmap==5.0.1
|
||||||
|
soupsieve==2.2.1
|
||||||
|
urllib3==2.0.4
|
||||||
|
BIN
screenshot.png
BIN
screenshot.png
Binary file not shown.
Before Width: | Height: | Size: 198 KiB After Width: | Height: | Size: 340 KiB |
73
styles.css
73
styles.css
@@ -1,73 +0,0 @@
|
|||||||
body {
|
|
||||||
font-family: "Open Sans", sans-serif;
|
|
||||||
color: #454545;
|
|
||||||
font-size: 16px;
|
|
||||||
margin: 2em auto;
|
|
||||||
max-width: 800px;
|
|
||||||
padding: 1em;
|
|
||||||
line-height: 1.4;
|
|
||||||
text-align: justify;
|
|
||||||
background-color: #fefefe;
|
|
||||||
overflow-wrap: break-word;
|
|
||||||
}
|
|
||||||
|
|
||||||
a { color: #07a; }
|
|
||||||
a:visited { color: #941352; }
|
|
||||||
|
|
||||||
img[class="centered"] {
|
|
||||||
margin: 0 auto;
|
|
||||||
display: block;
|
|
||||||
}
|
|
||||||
|
|
||||||
table {
|
|
||||||
border-collapse: collapse;
|
|
||||||
margin: 1em auto;
|
|
||||||
max-width: 100%;
|
|
||||||
}
|
|
||||||
th, td {
|
|
||||||
padding: 1em;
|
|
||||||
border: 1px solid #454545;
|
|
||||||
margin: 0;
|
|
||||||
}
|
|
||||||
|
|
||||||
|
|
||||||
pre {
|
|
||||||
background-color: #d9d9d9 ;
|
|
||||||
color: #000;
|
|
||||||
padding: 1em;
|
|
||||||
}
|
|
||||||
|
|
||||||
details {
|
|
||||||
padding: 1em 0 1em 0;
|
|
||||||
}
|
|
||||||
|
|
||||||
li {
|
|
||||||
margin-bottom: 1em;
|
|
||||||
}
|
|
||||||
|
|
||||||
img {
|
|
||||||
margin: 0 auto;
|
|
||||||
display: block;
|
|
||||||
max-width: 100%;
|
|
||||||
}
|
|
||||||
|
|
||||||
figcaption {
|
|
||||||
margin: 0 auto;
|
|
||||||
width: max-content;
|
|
||||||
}
|
|
||||||
|
|
||||||
.article {
|
|
||||||
margin: 1em;
|
|
||||||
}
|
|
||||||
|
|
||||||
blockquote {
|
|
||||||
border-left: 0.4em solid #454545;
|
|
||||||
margin-left: 0;
|
|
||||||
padding-left: 1em;
|
|
||||||
padding-top: 0.5em;
|
|
||||||
padding-bottom: 0.5em;
|
|
||||||
}
|
|
||||||
|
|
||||||
blockquote * {
|
|
||||||
margin: 0;
|
|
||||||
}
|
|
9
templates/article-text.html
Normal file
9
templates/article-text.html
Normal file
@@ -0,0 +1,9 @@
|
|||||||
|
{% extends "article.html" %}
|
||||||
|
{% block body_content %}
|
||||||
|
<p> This file was not rendered by gronk because it is a plaintext file, not a markdown
|
||||||
|
file.
|
||||||
|
You access the raw file <a href="{{ raw_link }}">here</a>.
|
||||||
|
Below is an unformatted representation of the file:
|
||||||
|
</p>
|
||||||
|
<pre>{{ raw_content }}</pre>
|
||||||
|
{% endblock %}
|
@@ -1,14 +1,65 @@
|
|||||||
<head>
|
{% extends "base.html" %}
|
||||||
<meta name="viewport" content="width=device-width, initial-scale=1">
|
{% block head %}
|
||||||
<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" />
|
|
||||||
<script src="https://polyfill.io/v3/polyfill.min.js?features=es6"></script>
|
<script src="https://polyfill.io/v3/polyfill.min.js?features=es6"></script>
|
||||||
|
<script>
|
||||||
|
MathJax = {
|
||||||
|
tex: {
|
||||||
|
tags: 'ams'
|
||||||
|
}
|
||||||
|
}
|
||||||
|
</script>
|
||||||
<script id="MathJax-script" async src="https://cdn.jsdelivr.net/npm/mathjax@3/es5/tex-mml-chtml.js"></script>
|
<script id="MathJax-script" async src="https://cdn.jsdelivr.net/npm/mathjax@3/es5/tex-mml-chtml.js"></script>
|
||||||
<title>$title$</title>
|
{% endblock %}
|
||||||
</head>
|
|
||||||
|
|
||||||
<body>
|
{% block content %}
|
||||||
$body$
|
<p class="smallText metadata"> title: {{ title }} </p>
|
||||||
<p style="font-size: 0.7em;"> page generated by <a href="https://github.com/alvierahman90/notes2web">notes2web</a></p>
|
{% if lecture_slides %}
|
||||||
</body>
|
<p class="smallText metadata"> lecture_slides: [
|
||||||
|
{% for slide in lecture_slides %}
|
||||||
|
<a href="{{ slide }}">{{ slide }}</a>{% if loop.nextitem %},{% endif %}
|
||||||
|
{% endfor %}
|
||||||
|
]</p>
|
||||||
|
{% endif %}
|
||||||
|
{% if lecture_notes %}
|
||||||
|
<p class="smallText metadata"> lecture_notes: [
|
||||||
|
{% for note in lecture_notes %}
|
||||||
|
<a href="{{ note }}">{{ note }}</a>{% if loop.nextitem %},{% endif %}
|
||||||
|
{% endfor %}
|
||||||
|
]</p>
|
||||||
|
{% endif %}
|
||||||
|
|
||||||
|
{% if uuid %}
|
||||||
|
<p class="smallText metadata"> uuid: {{ uuid }} (<a href="/permalink?uuid={{ uuid }}">permalink</a>) </p>
|
||||||
|
{% endif %}
|
||||||
|
|
||||||
|
<p class="smallText metadata"> tags: [
|
||||||
|
{% for tag in tags %}
|
||||||
|
<a href="/tags/{{ tag }}">{{ tag }}</a>{% if loop.nextitem %},{% endif %}
|
||||||
|
{% endfor %}
|
||||||
|
]</p>
|
||||||
|
<p class="smallText metadata">
|
||||||
|
{% if author is string %}
|
||||||
|
written by: {{ author }}
|
||||||
|
{% elif author is iterable %}
|
||||||
|
written by: [ {% for auth in author %}{{ auth }}{% if loop.nextitem %}, {% endif %}{% endfor %} ]
|
||||||
|
{% endif %}
|
||||||
|
</p>
|
||||||
|
<p class="smallText metadata">
|
||||||
|
syntax highlighting based on <a href="https://pygments.org/">Pygments'</a> default
|
||||||
|
colors
|
||||||
|
</p>
|
||||||
|
<p class="smallText metadata">
|
||||||
|
page generated by <a href="https://git.alv.cx/alvierahman90/gronk">gronk</a>
|
||||||
|
</p>
|
||||||
|
{% if license %}
|
||||||
|
<details id="license">
|
||||||
|
<summary class="smallText">
|
||||||
|
License
|
||||||
|
</summary>
|
||||||
|
<pre>{{ license }}</pre>
|
||||||
|
</details>
|
||||||
|
{% endif %}
|
||||||
|
{% block body_content %}
|
||||||
|
{{ content|safe }}
|
||||||
|
{% endblock %}
|
||||||
|
{% endblock %}
|
||||||
|
18
templates/base.html
Normal file
18
templates/base.html
Normal file
@@ -0,0 +1,18 @@
|
|||||||
|
<!DOCTYPE html>
|
||||||
|
<head>
|
||||||
|
<meta name="viewport" content="width=device-width, initial-scale=1, maximum-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="/css/styles.css" />
|
||||||
|
<title>{{ title }}</title>
|
||||||
|
{% block head %}
|
||||||
|
{% endblock %}
|
||||||
|
</head>
|
||||||
|
|
||||||
|
<body>
|
||||||
|
<div id="content">
|
||||||
|
{% block content %}
|
||||||
|
{% endblock %}
|
||||||
|
<p class="smallText"> page generated by <a href="https://github.com/alvierahman90/gronk">gronk</a> <!--(commit {{ gronk_commit }}) {% if notes_git_head_sha1 %}notes commit {{ notes_git_head_sha1 }}{% endif %}--></p>
|
||||||
|
</div>
|
||||||
|
</body>
|
@@ -1 +0,0 @@
|
|||||||
<p>These are my personal notes. Correctness is not guaranteed.</p>
|
|
18
templates/home.html
Normal file
18
templates/home.html
Normal file
@@ -0,0 +1,18 @@
|
|||||||
|
{% extends "article.html" %}
|
||||||
|
{% block content %}
|
||||||
|
{{ post['content']|safe }}
|
||||||
|
<p>
|
||||||
|
Browse <a href="/notes">here</a> or by tag <a href="/tags">here</a>.
|
||||||
|
</p>
|
||||||
|
|
||||||
|
<div id="searchWrapper">
|
||||||
|
<input autocomplete="off" placeholder="search" id="search" autofocus>
|
||||||
|
</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>
|
||||||
|
|
||||||
|
<script src="/js/fuse.js"> </script>
|
||||||
|
<script> const search_data = {{ search_data|tojson }} </script>
|
||||||
|
<script src="/js/search.js"> </script>
|
||||||
|
{% endblock %}
|
@@ -1,13 +1,33 @@
|
|||||||
<head>
|
{% extends "base.html" %}
|
||||||
<meta name="viewport" content="width=device-width, initial-scale=1">
|
{% block content %}
|
||||||
<meta charset="utf-8">
|
<h1>{{ title }}</h1>
|
||||||
<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>$title$</h1>
|
|
||||||
$body$
|
|
||||||
|
|
||||||
<p style="font-size: 0.7em;"> page generated by <a href="https://github.com/alvierahman90/notes2web">notes2web</a></p>
|
{% if not content_after_search %}
|
||||||
</body>
|
{{ content|safe }}
|
||||||
|
{% endif %}
|
||||||
|
|
||||||
|
{% if automatic_index %}
|
||||||
|
{% if search_bar %}
|
||||||
|
<div id="searchWrapper">
|
||||||
|
<input id="search" placeholder="search" autocomplete="off" autofocus>
|
||||||
|
</div>
|
||||||
|
<p class="searchSmallText" style="margin-top: 0; text-align: center">
|
||||||
|
Press (<kbd>Shift</kbd>+)<kbd>Enter</kbd> to open first result (in new tab)
|
||||||
|
</p>
|
||||||
|
{% endif %}
|
||||||
|
|
||||||
|
<ul id="searchResults" class="buttonlist">
|
||||||
|
<li class="article"><a href=".."><p>../</p></a></li>
|
||||||
|
{% for entry in index_entries %}
|
||||||
|
<li class="article"><a href="{{ entry['path'] }}"><p>{{ entry['title'] }}{% if entry['is_dir'] %}/{% endif %}</p></a></li>
|
||||||
|
{% endfor %}
|
||||||
|
</ul>
|
||||||
|
{% endif %}
|
||||||
|
|
||||||
|
{% if content_after_search %}
|
||||||
|
{{ content|safe }}
|
||||||
|
{% endif %}
|
||||||
|
<script src="/js/fuse.js"> </script>
|
||||||
|
<script> const search_data = {{ index_entries|tojson }} </script>
|
||||||
|
<script src="/js/indexsearch.js"> </script>
|
||||||
|
{% endblock %}
|
||||||
|
@@ -1,2 +0,0 @@
|
|||||||
<p style="font-size: 0.7em;"> page generated by <a href="https://github.com/alvierahman90/notes2web">notes2web</a></p>
|
|
||||||
</body>
|
|
@@ -1,12 +0,0 @@
|
|||||||
<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>$title$</h1>
|
|
||||||
$extra_content$
|
|
||||||
<div class="article"><a href="..">../</a></div>
|
|
@@ -1,7 +0,0 @@
|
|||||||
<li>
|
|
||||||
<a href="$filepath$"> $if(title)$
|
|
||||||
$title$
|
|
||||||
$else$
|
|
||||||
no title ($filepath$)
|
|
||||||
$endif$</a>
|
|
||||||
</li>
|
|
10
templates/permalink.html
Normal file
10
templates/permalink.html
Normal file
@@ -0,0 +1,10 @@
|
|||||||
|
{% block content %}
|
||||||
|
<p>
|
||||||
|
You should be being redirected...
|
||||||
|
Otherwise, click <a id="manual_redirect">here</a>.
|
||||||
|
</p>
|
||||||
|
|
||||||
|
<p class="smallText"> page generated by <a href="https://github.com/alvierahman90/gronk">gronk</a></p>
|
||||||
|
<script> const data = {{ data|tojson }} </script>
|
||||||
|
<script src="/js/permalink.js"> </script>
|
||||||
|
{% endblock %}
|
@@ -1,3 +0,0 @@
|
|||||||
</pre>
|
|
||||||
<p style="font-size: 0.7em;"> page generated by <a href="https://github.com/alvierahman90/notes2web">notes2web</a></p>
|
|
||||||
</body>
|
|
@@ -1,16 +0,0 @@
|
|||||||
<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>$title$</h1>
|
|
||||||
<p> This file was not rendered by notes2web because it is a plaintext file, not a markdown
|
|
||||||
file.
|
|
||||||
You access the raw file <a href="$raw$">here</a>.
|
|
||||||
Below is an unformatted representation of the file:
|
|
||||||
</p>
|
|
||||||
<pre>
|
|
Reference in New Issue
Block a user