small changes

Author: yaroslav

.gitignore

@@ -4,6 +4,7 @@ __pycache__/
 *.pyo
 *.pyd
 venv/
+.venv/
 .env
 *.log
 *.ipynb
@@ -15,5 +16,6 @@ tools/.ipynb_checkpoints/
 test_projects/
 
 build/
+dist/
 !tests/
 omd2tex.egg-info/

.python-version

@@ -0,0 +1 @@
+3.12

LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2025 Savateykin Yaroslav
+
+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.

README.md

@@ -1 +1,45 @@
-[Beamer theme list](https://github.com/martinbjeldbak/ultimate-beamer-theme-list?tab=readme-ov-file)
+# omd2tex
+
+Markdown to LaTeX converter specified for use with Obsidian.
+
+## Install
+
+```bash
+uv pip install omd2tex
+```
+
+## Development (uv)
+
+```bash
+uv venv
+uv pip install -e ".[dev,test,docs]"
+```
+
+Run tests:
+
+```bash
+uv run pytest
+```
+
+## Build and publish
+
+```bash
+uv pip install build twine
+uv run python -m build
+uv run twine upload dist/*
+```
+
+## Documentation
+
+```bash
+uv pip install -e ".[docs]"
+uv run sphinx-build -b html docs/source docs/_build/html
+```
+
+## References
+
+- [Beamer theme list](https://github.com/martinbjeldbak/ultimate-beamer-theme-list?tab=readme-ov-file)
+
+## License
+
+This project is licensed under the MIT License.

docs/README.md

@@ -1,29 +1,27 @@
 # Documentation
 
-Build the HTML docs locally.
+Build the HTML docs locally with uv.
 
 ## Setup
 
 ```bash
-python -m venv .venv
-source .venv/bin/activate  # or .venv\Scripts\activate on Windows
-pip install -r docs/requirements.txt
+uv venv
+uv pip install -e ".[docs]"
 ```
 
 ## Build HTML
 
 ```bash
-cd docs
-sphinx-build -b html source _build/html
+uv run sphinx-build -b html docs/source docs/_build/html
 ```
 
 Output appears in `docs/_build/html`. Open `index.html` in a browser to view.
 
 ## GitHub Pages
 
-GitHub Pages can publish the docs via GitHub Actions (Source: GitHub Actions). After pushing to `main`, enable Pages in Repository Settings → Pages with Source set to GitHub Actions.
+GitHub Pages can publish the docs via GitHub Actions (Source: GitHub Actions). After pushing to `main`, enable Pages in Repository Settings -> Pages with Source set to GitHub Actions.
 
-The site uses the PyData Sphinx Theme (pulled in via `docs/requirements.txt`).
+The site uses the PyData Sphinx Theme (pulled in via the `docs` extra).
 
 To serve from the `gh-pages` branch (recommended for this workflow):
-Settings → Pages → Build and deployment → Source: Deploy from a branch → Branch: `gh-pages` / folder: `/ (root)`.
+Settings -> Pages -> Build and deployment -> Source: Deploy from a branch -> Branch: `gh-pages` / folder: `/ (root)`.

docs/requirements.txt

@@ -0,0 +1 @@
+test)

notebooks/@citation1.md

@@ -0,0 +1 @@
+test)

notebooks/@citation2.md

@@ -0,0 +1 @@
+test)