@@ -35,6 +35,7 @@ a fantastic live search feature. **Poxy** builds upon both by:
3535- Adding support for C++20 concepts
3636- Adding [ tabbed content blocks] ( docs/aliases.md#tabbed-content ) (e.g. for showing the same example in multiple languages)
3737- Adding a top-level page listing all ` #defines ` so they're discoverable without hunting through file docs
38+ - Adding a [ blog] ( docs/blog.md ) with tags, drafts, per-post media, an RSS feed and a sitemap
3839- Self-hosting fonts to reduce external HTTP requests
3940- Inlining SVGs so they can take advantage of [ ` currentColor ` ]
4041- Keeping undocumented parents of documented symbols (and documented enums' values) instead of pruning them
@@ -72,9 +73,10 @@ pip install poxy
7273Poxy is a command-line application.
7374
7475```
75- usage: poxy [-h] [-v] [--html | --no-html] [--ppinclude <regex>] [--ppexclude <regex>]
76- [--theme {light,dark,custom}] [--threads N] [--version] [--xml | --no-xml]
77- [--werror | --no-werror] [--bug-report] [--git-tags]
76+ usage: poxy [-h] [-v] [--html | --no-html] [--ppinclude <regex>]
77+ [--ppexclude <regex>] [--theme {light,dark,custom}] [--threads N]
78+ [--version] [--xml | --no-xml] [--werror | --no-werror]
79+ [--drafts | --no-drafts] [--bug-report] [--git-tags]
7880 [--squash-patches | --no-squash-patches] [--min-version <version>]
7981 [config]
8082
@@ -83,7 +85,7 @@ usage: poxy [-h] [-v] [--html | --no-html] [--ppinclude <regex>] [--ppexclude <r
8385 | |_) | (_) > <| |_| |
8486 | .__/ \___/_/\_\\__, |
8587 | | __/ |
86- |_| |___/ v0.17.0 - github.com/marzer/poxy
88+ |_| |___/ v0.25.1 - github.com/marzer/poxy
8789
8890Generate fancy C++ documentation.
8991
@@ -103,6 +105,8 @@ options:
103105 --xml, --no-xml specify whether XML output is required
104106 --werror, --no-werror
105107 treat warnings as errors (default: read from config)
108+ --drafts, --no-drafts
109+ include blog posts marked as drafts (default: read from config)
106110 --bug-report captures all output in a zip file for easier bug reporting.
107111 --git-tags add git-tag-based semver version switcher to the generated HTML
108112 --squash-patches, --no-squash-patches
@@ -127,12 +131,28 @@ Full documentation lives in the [`docs`](docs) directory:
127131
128132- [ What poxy does over Doxygen + m.css] ( docs/improvements.md )
129133- [ Configuration options] ( docs/configuration.md ) - every ` poxy.toml ` option
134+ - [ Blog] ( docs/blog.md ) - writing posts, tags, drafts and feeds
130135- [ Doxygen @alias commands] ( docs/aliases.md ) - the extra ` @commands ` poxy provides
131136- [ Square-bracket tags] ( docs/tags.md ) - inline control of the generated HTML
132137
133138For a self-contained ` poxy.toml ` example to copy and paste from,
134139see [ the one used by toml++] ( https://github.com/marzer/tomlplusplus/blob/master/docs/poxy.toml ) .
135140
141+ ### Blogging
142+
143+ Poxy doubles as a small static blogging platform. ` poxyblog ` scaffolds a post:
144+
145+ ```
146+ usage: poxyblog [-h] [--tags <a,b,c>] [--date <YYYY-MM-DD>] [--draft] [--dir]
147+ [--force] [-v] [--version]
148+ [config] [title]
149+
150+ Initializes a new blog post for Poxy sites.
151+ ```
152+
153+ Posts are markdown with optional TOML front matter, and get an index, tags, an RSS feed and a sitemap.
154+ See the [ blog documentation] ( docs/blog.md ) .
155+
136156<br ><br >
137157
138158## Migrating from Doxygen
0 commit comments