added readme

This commit is contained in:
ronny abraham 2025-04-27 17:21:33 +03:00
parent 5116034cab
commit 9762a87176

62
readme.md Normal file
View file

@ -0,0 +1,62 @@
# org-media-sass
Reusable SASS media styles for Org-mode and HTML exports.
## Repository Info
- **Source:** [Forgejo](https://forgejo.ronnyabraham.com)
- **Clone URL:**
ssh://git@forgejo.ronnyabraham.com:222/notes/org-media-sass.git
## Project Structure
- Location in project: _media/share/sass/org-media-sass
- Expected fonts directory: _media/share/fonts
- Output CSS directory: _media/share/css
## Adding as a submodule
git submodule add ssh://git@forgejo.ronnyabraham.com:222/notes/org-media-sass.git _media/share/sass/org-media-sass
git add .gitmodules _media/share/sass/org-media-sass
git commit -m "Added org-media-sass submodule"
### Generating CSS
From the _media/share/ directory:
sass --watch sass:css
This watches the sass/ folder and outputs compiled .css files into css/.
### Cloning with submodules
git clone ssh://git@forgejo.ronnyabraham.com:222/your/main-project.git
cd main-project
git submodule update --init --recursive
### Notes
- Forgejo runs on port 222; ensure your SSH client allows connections on this port.
- Fonts must be placed in _media/share/fonts.
- Use sass --watch during development to keep CSS up-to-date.
### Optional: SSH Config Shortcut
Add this to your ~/.ssh/config:
Host forgejo
HostName forgejo.ronnyabraham.com
Port 222
User git
Then you can use
git clone forgejo:notes/org-media-sass.git
git submodule add forgejo:notes/org-media-sass.git _media/share/sass/org-media-sass