A simple and powerful documentation converter for transforming Markdown files into beautifully formatted HTML documentation.
- Easy Conversion: Convert Markdown files to HTML with a single click
- Live Preview: See your converted documentation in real-time
- Clean Interface: Minimalist design focused on functionality
- Export Options: Save your converted HTML documentation locally
- No Registration Required: Start using immediately without signup
- Responsive Output: Generated HTML works perfectly on all devices
- Fast Processing: Quick conversion without compromising quality
Check out the live demo at: https://docmark.lonelypx.com/
# Clone the repository
git clone https://github.com/lonelypx/DocMark.git
# Navigate to the project directory
cd DocMark
# Install dependencies (if using Node.js)
npm install
# Start the development server
npm startSimply visit https://docmark.lonelypx.com/ to use DocMark online without any installation.
- Input Your Markdown: Paste or type your Markdown content into the editor
- Preview: Use the preview feature to see how your documentation will look
- Export: Click "Export HTML" to download your converted documentation
- Headers (H1-H6)
- Text Formatting (bold, italic, strikethrough)
- Lists (ordered and unordered)
- Links and Images
- Code Blocks (with syntax highlighting)
- Tables
- Blockquotes
- Horizontal Rules
- Line Breaks
DocMark supports multiple themes for your documentation:
- Default
- Dark Mode
- Minimal
- Corporate
You can customize the appearance by adding your own CSS:
<style>
/* Your custom styles here */
.docmark-content {
font-family: 'Your Preferred Font', sans-serif;
}
</style>Create a docmark.config.js file in your project root:
module.exports = {
input: './docs',
output: './dist',
theme: 'default',
title: 'My Documentation',
author: 'Your Name',
includeCSS: true,
minify: true
};Converts Markdown content to HTML.
Parameters:
markdown(string): The Markdown content to convertoptions(object): Configuration options
Returns:
string: The converted HTML content
Example:
const html = DocMark.convert('# Hello\nWorld!', {
title: 'My Document'
});| Option | Type | Default | Description |
|---|---|---|---|
title |
string | 'Document' | Document title |
theme |
string | 'default' | Theme name |
includeCSS |
boolean | true | Include default CSS |
minify |
boolean | false | Minify output HTML |
We welcome contributions! Please see our Contributing Guidelines for details.
- Fork the repository
- Create your feature branch (
git checkout -b feature/amazing-feature) - Commit your changes (
git commit -m 'Add some amazing feature') - Push to the branch (
git push origin feature/amazing-feature) - Open a Pull Request
# Run all tests
npm test
# Run tests in watch mode
npm run test:watch
# Run tests with coverage
npm run test:coverageDocMark/
├── src/
│ ├── components/
│ ├── styles/
│ ├── utils/
│ └── index.js
├── public/
├── tests/
├── docs/
├── package.json
└── README.md
- MkDocs - Static site generator for documentation
- Pandoc - Universal document converter
- Gitiles - Git repository browser
This project is licensed under the MIT License - see the LICENSE file for details.
- Documentation: Wiki
- Issues: GitHub Issues
- Discussions: GitHub Discussions
- Thanks to all contributors who have helped shape DocMark
- Inspired by the need for simple, efficient documentation tools
- Built with love for the developer community
- Initial release
- Basic Markdown to HTML conversion
- Web interface
- Export functionality
| Browser | Version |
|---|---|
| Chrome | 60+ |
| Firefox | 55+ |
| Safari | 12+ |
| Edge | 79+ |
Made with ❤️ by lonelypx
Star ⭐ this repository if you find it helpful!