Mirror/Crow
1
0
Fork 0
mirror of https://github.com/CrowCpp/Crow.git synced 2024-06-07 21:10:44 +00:00
Code Issues Packages Projects Releases Wiki Activity
e688cbd18e
Crow/mkdocs.yml

87 lines
2.4 KiB
YAML
Raw Normal View History

Changed documentation. a lot. Added mkdocs documentation. Altered doxygen generation (doxyfile and shell script) to work with mkdocs. Removed the whole html folder thing for docs, now the files reside in the root gh-pages branch. New readme.
2020-11-28 14:28:47 +00:00
site_name: Crow
# Repository
small fixes, optimizations, and documentation
2021-07-30 10:09:01 +00:00
repo_name: CrowCpp/Crow
repo_url: https://github.com/CrowCpp/Crow
site_url: https://crowcpp.org
Changed documentation. a lot. Added mkdocs documentation. Altered doxygen generation (doxyfile and shell script) to work with mkdocs. Removed the whole html folder thing for docs, now the files reside in the root gh-pages branch. New readme.
2020-11-28 14:28:47 +00:00
edit_uri: ""
theme:
name: material
font: false
language: 'en'
features:
navigation.tabs
favicon: 'assets/favicon.svg'
logo: 'assets/favicon.svg'
icon:
repo: fontawesome/brands/github-square
Updated site: Added analytics via matomo (analytics hosted on my personal site), also added privacy policy page with link in footer Updated code colors to match light theme Added display for Crow's financial supporters on OpenCollective Fixed Sidebar issue on narrow screens Fixed Get crow Icons being misaligned
2021-09-29 22:49:08 +00:00
static_templates:
- privacy_policy.html
added missing changes to README and mkdocs.yml
2021-08-13 01:00:28 +00:00
custom_dir: docs/overrides
Changed documentation. a lot. Added mkdocs documentation. Altered doxygen generation (doxyfile and shell script) to work with mkdocs. Removed the whole html folder thing for docs, now the files reside in the root gh-pages branch. New readme.
2020-11-28 14:28:47 +00:00
markdown_extensions:
added documentation for testing, proxies, and systemd setup
2021-01-05 05:59:32 +00:00
- admonition
Changed documentation. a lot. Added mkdocs documentation. Altered doxygen generation (doxyfile and shell script) to work with mkdocs. Removed the whole html folder thing for docs, now the files reside in the root gh-pages branch. New readme.
2020-11-28 14:28:47 +00:00
- pymdownx.highlight
Updated site: Added analytics via matomo (analytics hosted on my personal site), also added privacy policy page with link in footer Updated code colors to match light theme Added display for Crow's financial supporters on OpenCollective Fixed Sidebar issue on narrow screens Fixed Get crow Icons being misaligned
2021-09-29 22:49:08 +00:00
- pymdownx.tabbed
Changed documentation. a lot. Added mkdocs documentation. Altered doxygen generation (doxyfile and shell script) to work with mkdocs. Removed the whole html folder thing for docs, now the files reside in the root gh-pages branch. New readme.
2020-11-28 14:28:47 +00:00
- pymdownx.superfences
- pymdownx.inlinehilite
- pymdownx.keys
nav:
- Home: index.md
- Getting Started:
Added updated setup instructions (kept old instructions as "legacy")
2021-09-29 22:43:50 +00:00
- Setup:
- Linux: getting_started/setup/linux.md
- MacOS: getting_started/setup/macos.md
- Windows: getting_started/setup/windows.md
- Legacy: getting_started/setup/legacy.md
Changed documentation. a lot. Added mkdocs documentation. Altered doxygen generation (doxyfile and shell script) to work with mkdocs. Removed the whole html folder thing for docs, now the files reside in the root gh-pages branch. New readme.
2020-11-28 14:28:47 +00:00
- Your First Application: getting_started/your_first_application.md
- Guides:
- Different parts of Crow:
- App: guides/app.md
- Routes: guides/routes.md
- Logging: guides/logging.md
- JSON: guides/json.md
- Templating (Mustache): guides/templating.md
- Multipart: guides/multipart.md
Quality of life improvements Added pop() method to query_string, same as get(), but removes the item from the querystring Added std::string() operator to json::rvalue (allows std::string(json["abc"]), which returns any value that isn't a container to string) Added lo() method to json::rvalue, returns a vector of json::rvalue containing whatever a json object or list has (difference being a list has no keys) Added keys() method to json::rvalue, returns a vector of std::string containing the keys of a json object Made json::wvalue use either std::map or std::unordered_map instead of just std::unordered_map Added copy constructor to json::wvalue Added size() method to json::wvalue, returns 1 or the size of the json list. Added constructor to create json::wvalue from std::vector Added keys() method to query_string Documented query_string and improved json doc Made tests and examples for all the additions
2021-05-12 12:45:55 +00:00
- Query Strings: guides/query-string.md
Changed documentation. a lot. Added mkdocs documentation. Altered doxygen generation (doxyfile and shell script) to work with mkdocs. Removed the whole html folder thing for docs, now the files reside in the root gh-pages branch. New readme.
2020-11-28 14:28:47 +00:00
- Middleware: guides/middleware.md
- SSL: guides/ssl.md
- Static Files: guides/static.md
small fixes, optimizations, and documentation
2021-07-30 10:09:01 +00:00
- Blueprints: guides/blueprints.md
updated documentation to fix a few mistakes, clear up a few points, and added compression guide
2021-06-03 14:12:48 +00:00
- Compression: guides/compression.md
Changed documentation. a lot. Added mkdocs documentation. Altered doxygen generation (doxyfile and shell script) to work with mkdocs. Removed the whole html folder thing for docs, now the files reside in the root gh-pages branch. New readme.
2020-11-28 14:28:47 +00:00
- Websockets: guides/websockets.md
added documentation for testing, proxies, and systemd setup
2021-01-05 05:59:32 +00:00
- Writing Tests: guides/testing.md
Updated documentation: added auth guide updated macos setup
2021-12-03 03:38:14 +00:00
- Using Crow:
- HTTP Authorization: guides/auth.md
Changed documentation. a lot. Added mkdocs documentation. Altered doxygen generation (doxyfile and shell script) to work with mkdocs. Removed the whole html folder thing for docs, now the files reside in the root gh-pages branch. New readme.
2020-11-28 14:28:47 +00:00
- Server setup:
- Proxies: guides/proxies.md
- Systemd run on startup: guides/syste.md
- API Reference:
patch for mkdocs, worked on my repo, not sure if it'll work here
2020-11-29 22:33:06 +00:00
- API Reference: 'reference/index.html'
Changed documentation. a lot. Added mkdocs documentation. Altered doxygen generation (doxyfile and shell script) to work with mkdocs. Removed the whole html folder thing for docs, now the files reside in the root gh-pages branch. New readme.
2020-11-28 14:28:47 +00:00
extra:
Updated site: Added analytics via matomo (analytics hosted on my personal site), also added privacy policy page with link in footer Updated code colors to match light theme Added display for Crow's financial supporters on OpenCollective Fixed Sidebar issue on narrow screens Fixed Get crow Icons being misaligned
2021-09-29 22:49:08 +00:00
analytics:
provider: matomo
id: 1
link: //thee.dev/matomo/
Changed documentation. a lot. Added mkdocs documentation. Altered doxygen generation (doxyfile and shell script) to work with mkdocs. Removed the whole html folder thing for docs, now the files reside in the root gh-pages branch. New readme.
2020-11-28 14:28:47 +00:00
social:
- icon: fontawesome/brands/github
Updated all URLs for migration and to fix mkdocs
2020-11-30 20:05:55 +00:00
link: https://github.com/crowcpp/crow
Changed documentation. a lot. Added mkdocs documentation. Altered doxygen generation (doxyfile and shell script) to work with mkdocs. Removed the whole html folder thing for docs, now the files reside in the root gh-pages branch. New readme.
2020-11-28 14:28:47 +00:00
- icon: fontawesome/brands/gitter
link: https://gitter.im/crowfork/community
added getting_started URL redirection
2021-10-06 10:34:37 +00:00
plugins:
- redirects:
redirect_maps:
'getting_started/setup/': 'getting_started/setup/linux.md'
multiple docs changes: Added meta tags for homepage Added meta description generator Removed usages of <h1> (mkdocs-material doesn't reconize more than 1) added space after # (markdown proper syntax) removed pip3 command from pull request CI
2021-11-06 08:54:29 +00:00
- meta-descriptions
added getting_started URL redirection
2021-10-06 10:34:37 +00:00
Changed documentation. a lot. Added mkdocs documentation. Altered doxygen generation (doxyfile and shell script) to work with mkdocs. Removed the whole html folder thing for docs, now the files reside in the root gh-pages branch. New readme.
2020-11-28 14:28:47 +00:00
extra_css:
- 'stylesheets/colors.css'
- 'stylesheets/latofonts.css'
added missing changes to README and mkdocs.yml
2021-08-13 01:00:28 +00:00
- 'stylesheets/extra.css'
Changed documentation. a lot. Added mkdocs documentation. Altered doxygen generation (doxyfile and shell script) to work with mkdocs. Removed the whole html folder thing for docs, now the files reside in the root gh-pages branch. New readme.
2020-11-28 14:28:47 +00:00
added missing changes to README and mkdocs.yml
2021-08-13 01:00:28 +00:00
copyright: 'Copyright &copy; 2020-2021 CrowCpp'
Reference in New Issue Copy Permalink