|
1 |
| -# demo |
| 1 | +# Welcome to Flowershow Demo! |
| 2 | + |
| 3 | +This site is published from https://github.com/flowershow/demo using [Flowershow](https://flowershow.app) - an elegant solution for publishing your Obsidian vaults and Markdown content directly from GitHub repositories. |
| 4 | + |
| 5 | +## 🎯 What's Inside? |
| 6 | + |
| 7 | +This demo showcases various Flowershow features and configuration options: |
| 8 | + |
| 9 | +- 📝 **Rich Markdown Support** |
| 10 | + - Tables, code blocks, and diagrams |
| 11 | + - Math equations and LaTeX |
| 12 | + - Callouts and blockquotes |
| 13 | + - Obsidian wiki-links |
| 14 | + - And much more! |
| 15 | + |
| 16 | +- 🎨 **Customization Options** |
| 17 | + - Comments |
| 18 | + - Navigation setup |
| 19 | + - Custom domain |
| 20 | + |
| 21 | +## 📚 Markdown Syntax Examples |
| 22 | + |
| 23 | +### Text Formatting |
| 24 | + |
| 25 | +**Bold text** and *italic text* and ***bold italic text*** |
| 26 | + |
| 27 | +~~Strikethrough text~~ |
| 28 | + |
| 29 | +`Inline code` |
| 30 | + |
| 31 | +==Highlighted text== |
| 32 | + |
| 33 | +### Lists |
| 34 | + |
| 35 | +Unordered list: |
| 36 | +* Item 1 |
| 37 | +* Item 2 |
| 38 | + * Nested item 2.1 |
| 39 | + * Nested item 2.2 |
| 40 | +* Item 3 |
| 41 | + |
| 42 | +Ordered list: |
| 43 | +1. First item |
| 44 | +2. Second item |
| 45 | + 1. Nested item 2.1 |
| 46 | + 2. Nested item 2.2 |
| 47 | +3. Third item |
| 48 | + |
| 49 | +### Task Lists |
| 50 | + |
| 51 | +- [x] Completed task |
| 52 | +- [ ] Incomplete task |
| 53 | +- [ ] Another task |
| 54 | + - [x] Nested completed task |
| 55 | + - [ ] Nested incomplete task |
| 56 | + |
| 57 | +### Code Blocks |
| 58 | + |
| 59 | +Inline code: `const greeting = "Hello, World!";` |
| 60 | + |
| 61 | +```javascript |
| 62 | +// JavaScript example |
| 63 | +function calculateSum(a, b) { |
| 64 | + return a + b; |
| 65 | +} |
| 66 | + |
| 67 | +const result = calculateSum(5, 3); |
| 68 | +console.log(result); // Output: 8 |
| 69 | +``` |
| 70 | + |
| 71 | +```python |
| 72 | +# Python example |
| 73 | +def greet(name): |
| 74 | + return f"Hello, {name}!" |
| 75 | + |
| 76 | +print(greet("Flowershow")) |
| 77 | +``` |
| 78 | + |
| 79 | +### Tables |
| 80 | + |
| 81 | +| Book Type | Average Length | Reading Time | |
| 82 | +|-----------|---------------|--------------| |
| 83 | +| Novel | 300 pages | 5 hours | |
| 84 | +| Magazine | 50 pages | 1 hour | |
| 85 | +| Comic Book | 30 pages | 30 minutes | |
| 86 | +| Cookbook | 200 pages | 2 hours | |
| 87 | + |
| 88 | +### Blockquotes |
| 89 | + |
| 90 | +> Single line quote |
| 91 | +
|
| 92 | +> Multi-line quote |
| 93 | +> with multiple paragraphs |
| 94 | +> > Nested quote |
| 95 | +> > > Deeper nested quote |
| 96 | +
|
| 97 | +### Links and Images |
| 98 | + |
| 99 | +(`[Visit Flowershow Website](https://flowershow.app)`) [Visit Flowershow Website](https://flowershow.app) |
| 100 | + |
| 101 | +(``)  |
| 102 | + |
| 103 | +### Obsidian Wiki-links |
| 104 | + |
| 105 | +Flowershow supports Obsidian-style wiki-links. For example, this links to our example blog post: (`[[abc]]`) [[abc]] |
| 106 | + |
| 107 | +You can also use the full path: (`[[blog/abc]]`) [[blog/abc]] |
| 108 | + |
| 109 | +And use Obsidian-style image embedding: (`![[lotus.png]]`) ![[lotus.png]] |
| 110 | + |
| 111 | +### Math Equations |
| 112 | + |
| 113 | +TBD |
| 114 | + |
| 115 | +### Diagrams |
| 116 | + |
| 117 | +```mermaid |
| 118 | +graph TD |
| 119 | + A[Start] --> B{Decision} |
| 120 | + B -->|Yes| C[Do Something] |
| 121 | + B -->|No| D[Do Nothing] |
| 122 | + C --> E[End] |
| 123 | + D --> E |
| 124 | +``` |
| 125 | + |
| 126 | +### Callouts |
| 127 | + |
| 128 | +> [!NOTE] |
| 129 | +> This is a note callout |
| 130 | +
|
| 131 | +> [!WARNING] |
| 132 | +> This is a warning callout |
| 133 | +
|
| 134 | +> [!TIP] |
| 135 | +> This is a tip callout |
| 136 | +
|
| 137 | +> [!IMPORTANT] |
| 138 | +> This is an important callout |
| 139 | +
|
| 140 | +### Footnotes |
| 141 | + |
| 142 | +Here's a sentence with a footnote[^1]. |
| 143 | + |
| 144 | +[^1]: This is the footnote content. |
| 145 | + |
| 146 | +### Horizontal Rules |
| 147 | + |
| 148 | +--- |
| 149 | +*** |
| 150 | +___ |
| 151 | + |
| 152 | + |
| 153 | +## ⚙️ Customization Options |
| 154 | + |
| 155 | +### Comments |
| 156 | + |
| 157 | +The comments section you can see at the bottom of this page has been enabled through the Flowershow Cloud dashboard. This feature allows your readers to engage with your content and provide feedback directly on your pages. |
| 158 | + |
| 159 | +### Navigation |
| 160 | + |
| 161 | +The site's navigation elements including the logo, title ("My Digital Garden"), links (About), and social media links (GitHub, Twitter) have been configured using the [`config.json`](https://github.com/flowershow/demo/blob/main/config.json) file. This configuration provides a clean way to customize your site's header without modifying the source code. |
| 162 | + |
| 163 | +### Custom Domain |
| 164 | + |
| 165 | +Looking at the URL of this site, you'll notice it's available at a custom domain instead of the default Flowershow Cloud URL pattern (`/@username/sitename`). This is another customization option available through the Flowershow Cloud dashboard, allowing you to use your own domain name for a more professional appearance. |
| 166 | + |
| 167 | + |
| 168 | +## 🤝 Contributing |
| 169 | + |
| 170 | +Have a suggestion? Feel free to: |
| 171 | +1. Open an issue |
| 172 | +2. Submit a pull request |
| 173 | +3. Start a discussion |
| 174 | + |
| 175 | +--- |
| 176 | + |
| 177 | +*Built with 💖 using [Flowershow](https://flowershow.app)* |
0 commit comments