Docgen Obsidian theme 0.1.0

This commit is contained in:
Maxim Stepanov 2026-07-08 12:20:38 +03:00
commit d07c2bf83c
No known key found for this signature in database
GPG key ID: CD3E87B04BBE85F3
13 changed files with 623 additions and 0 deletions

1
.gitignore vendored Normal file
View file

@ -0,0 +1 @@
.DS_Store

27
LICENSE Normal file
View file

@ -0,0 +1,27 @@
MIT License
Copyright (c) 2026 Maxim Stepanov
Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.
---
The bundled Geist and Geist Mono fonts (embedded in theme.css and included in
fonts/) are © Vercel, Inc. and are licensed separately under the SIL Open Font
License, Version 1.1. See LICENSE-Geist.txt.

91
LICENSE-Geist.txt Normal file
View file

@ -0,0 +1,91 @@
Copyright (c) 2023 Vercel, Inc. (https://vercel.com)
with Reserved Font Name "Geist".
This Font Software is licensed under the SIL Open Font License, Version 1.1.
This license is copied below, and is also available with a FAQ at:
https://openfontlicense.org
-----------------------------------------------------------
SIL OPEN FONT LICENSE Version 1.1 - 26 February 2007
-----------------------------------------------------------
PREAMBLE
The goals of the Open Font License (OFL) are to stimulate worldwide
development of collaborative font projects, to support the font creation
efforts of academic and linguistic communities, and to provide a free and
open framework in which fonts may be shared and improved in partnership
with others.
The OFL allows the licensed fonts to be used, studied, modified and
redistributed freely as long as they are not sold by themselves. The
fonts, including any derivative works, can be bundled, embedded,
redistributed and/or sold with any software provided that any reserved
names are not used by derivative works. The fonts and derivatives,
however, cannot be released under any other type of license. The
requirement for fonts to remain under this license does not apply to any
document created using the fonts or their derivatives.
DEFINITIONS
"Font Software" refers to the set of files released by the Copyright
Holder(s) under this license and clearly marked as such. This may include
source files, build scripts and documentation.
"Reserved Font Name" refers to any names specified as such after the
copyright statement(s).
"Original Version" refers to the collection of Font Software components as
distributed by the Copyright Holder(s).
"Modified Version" refers to any derivative made by adding to, deleting,
or substituting -- in part or in whole -- any of the components of the
Original Version, by changing formats or by porting the Font Software to a
new environment.
"Author" refers to any designer, engineer, programmer, technical writer or
other person who contributed to the Font Software.
PERMISSION & CONDITIONS
Permission is hereby granted, free of charge, to any person obtaining a
copy of the Font Software, to use, study, copy, merge, embed, modify,
redistribute, and sell modified and unmodified copies of the Font
Software, subject to the following conditions:
1) Neither the Font Software nor any of its individual components, in
Original or Modified Versions, may be sold by itself.
2) Original or Modified Versions of the Font Software may be bundled,
redistributed and/or sold with any software, provided that each copy
contains the above copyright notice and this license. These can be
included either as stand-alone text files, human-readable headers or in
the appropriate machine-readable metadata fields within text or binary
files as long as those fields can be easily viewed by the user.
3) No Modified Version of the Font Software may use the Reserved Font
Name(s) unless explicit written permission is granted by the corresponding
Copyright Holder. This restriction only applies to the primary font name as
presented to the users.
4) The name(s) of the Copyright Holder(s) or the Author(s) of the Font
Software shall not be used to promote, endorse or advertise any Modified
Version, except to acknowledge the contribution(s) of the Copyright
Holder(s) and the Author(s) or with their explicit written permission.
5) The Font Software, modified or unmodified, in part or in whole, must be
distributed entirely under this license, and must not be distributed under
any other license. The requirement for fonts to remain under this license
does not apply to any document created using the Font Software.
TERMINATION
This license becomes null and void if any of the above conditions are not
met.
DISCLAIMER
THE FONT SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO ANY WARRANTIES OF
MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT OF
COPYRIGHT, PATENT, TRADEMARK, OR OTHER RIGHT. IN NO EVENT SHALL THE
COPYRIGHT HOLDER BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
INCLUDING ANY GENERAL, SPECIAL, INDIRECT, INCIDENTAL, OR CONSEQUENTIAL
DAMAGES, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF THE USE OR INABILITY TO USE THE FONT SOFTWARE OR FROM OTHER DEALINGS
IN THE FONT SOFTWARE.

45
README.md Normal file
View file

@ -0,0 +1,45 @@
# Docgen — an Obsidian theme
A warm, near-black documentation theme for [Obsidian](https://obsidian.md),
modeled after the aesthetic of the **docgen** documentation generator
([docgen-rs](https://github.com/IamMaxim/docgen-rs)). Honey-amber accents on a
warm near-black surface, set in [Geist](https://vercel.com/font). Dark is the
primary mode; a light mode ships alongside it.
![Docgen theme screenshot](screenshot.png)
## Features
- **Warm near-black palette** with a honey-amber accent — easy on the eyes for
long documentation sessions.
- **Geist + Geist Mono**, embedded directly in `theme.css` as base64 so the
fonts render regardless of how Obsidian injects the stylesheet (no external
font requests, works fully offline).
- **Dark and light modes**, both tuned from the same token set.
## Installation
### From the community themes directory (once published)
1. Open **Settings → Appearance → Themes → Manage**.
2. Search for **Docgen** and select **Install and use**.
### Manual installation
1. Download `manifest.json` and `theme.css` from the
[latest release](https://github.com/IamMaxim/obsidian-docgen-theme/releases/latest).
2. In your vault, create the folder `.obsidian/themes/Docgen/` and place both
files inside it.
3. Open **Settings → Appearance → Themes** and select **Docgen**.
## Development
`theme.css` is the single source of truth and is self-contained — the Geist
fonts are inlined, so no build step is required to use it. The original
`.woff2` sources live in `fonts/` for reference and re-embedding.
## Credits & license
- Theme CSS: [MIT](LICENSE) © Maxim Stepanov.
- [Geist](https://vercel.com/font) and Geist Mono fonts: © Vercel, Inc.,
licensed under the [SIL Open Font License 1.1](LICENSE-Geist.txt).

BIN
fonts/geist-400.woff2 Normal file

Binary file not shown.

BIN
fonts/geist-500.woff2 Normal file

Binary file not shown.

BIN
fonts/geist-600.woff2 Normal file

Binary file not shown.

BIN
fonts/geist-700.woff2 Normal file

Binary file not shown.

BIN
fonts/geist-mono-400.woff2 Normal file

Binary file not shown.

BIN
fonts/geist-mono-500.woff2 Normal file

Binary file not shown.

BIN
fonts/geist-mono-600.woff2 Normal file

Binary file not shown.

7
manifest.json Normal file
View file

@ -0,0 +1,7 @@
{
"name": "Docgen",
"version": "0.1.0",
"minAppVersion": "1.5.0",
"author": "Maxim Stepanov",
"authorUrl": "https://github.com/IamMaxim"
}

452
theme.css Normal file

File diff suppressed because one or more lines are too long