Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/b-sullender/mdview
Preview Markdown files in your web browser directly from GNOME Nautilus with a simple right-click!
https://github.com/b-sullender/mdview
debian documentation linux markdown nautilus
Last synced: about 1 month ago
JSON representation
Preview Markdown files in your web browser directly from GNOME Nautilus with a simple right-click!
- Host: GitHub
- URL: https://github.com/b-sullender/mdview
- Owner: b-sullender
- License: mit
- Created: 2024-11-24T17:24:51.000Z (about 2 months ago)
- Default Branch: main
- Last Pushed: 2024-12-02T01:39:38.000Z (about 1 month ago)
- Last Synced: 2024-12-02T02:34:27.817Z (about 1 month ago)
- Topics: debian, documentation, linux, markdown, nautilus
- Language: CSS
- Homepage:
- Size: 12.7 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# 🖥️ **mdview**
Effortlessly view your Markdown files in your web browser directly from GNOME Nautilus on Linux.
✨ **How it works:**
Right-click any `.md` file in Nautilus and select **"View in Browser"** to instantly open and render your Markdown content in your default browser.
⚡ **As simple as: Write → View → Print**
---
## 🚀 **Features**
- **Seamless Integration**: Adds a simple context menu option in GNOME Nautilus.
- **Open-Source & Lightweight**: Built with simplicity and Linux-first design.
---
## 📦 **Dependencies**
Ensure the following packages are installed:
### For Debian-based systems:
- **php**
- **python3-nautilus**
- **php-parsedown**
- **php-parsedown-extra**
- **highlight.js**
- **mathjax**
Install them all at once with:
```bash
sudo apt install -y php python3-nautilus php-parsedown php-parsedown-extra libjs-highlight.js libjs-mathjax
```
---
## 🛠️ **Installation**
1. Clone the repository and navigate to the project folder.
2. Install with:
```bash
sudo make install
```
3. Restart Nautilus to apply changes:
```bash
nautilus -q && nautilus
```
You're good to go! 🎉
---
## ❌ **Uninstalling**
Want to remove `mdview`? No problem!
Simply run:
```bash
sudo make uninstall
```
---
## ⚙️ **Temporary File Handling**
When Markdown files are converted to HTML, they are saved as a temporary file in `/tmp`. As a result, refreshing the browser does not reflect any changes made to the Markdown file. To view updates, close the browser tab and reopen the Markdown file.
---
## 🏗️ **Building Debian Package**
If you wish to build a Debian package, follow these steps:
1. **Ensure the `rules` file is executable**:
```bash
sudo chmod +x debian/rules
```
2. **Build the package**:
- Without signing:
```bash
sudo dpkg-buildpackage -uc -us
```
- With signing (replace `` with your GPG key ID):
```bash
sudo dpkg-buildpackage -k
```
*To list your GPG keys, use `gpg --list-keys`.*
3. **Cleanup build files**:
After building the package, remove temporary files with:
```bash
sudo debclean
```
*This ensures your workspace is clean and free of leftover build artifacts.*
### Notes:
- Ensure you use `sudo` for all commands.
- Your newly created package files will be in the parent directory.
---
### 📜 **License**
`mdview` is open-source software, licensed under the [MIT License](LICENSE). Contributions are welcome!
---
💡 Let us know how you're using `mdview` or contribute to the project. Happy Markdowning!