From c0dab050630f13356da9bee8108462fb78bba0d3 Mon Sep 17 00:00:00 2001 From: Mattia Iavarone Date: Sun, 5 Jan 2020 20:59:27 +0100 Subject: [PATCH] Use Jekyll collections --- .../changelog.md} | 2 -- .../getting-started.md} | 2 -- .../install.md} | 2 -- docs/_config.yml | 33 ++++++++----------- .../camera-events.md} | 2 -- .../capture-size.md} | 2 -- .../capturing-media.md} | 2 -- .../controls.md} | 2 -- .../debugging.md} | 2 -- .../error-handling.md} | 2 -- .../filters.md} | 2 -- .../frame-processing.md} | 2 -- .../gestures.md} | 2 -- .../metering.md} | 2 -- .../more-features.md} | 2 -- .../preview-size.md} | 2 -- .../previews.md} | 2 -- .../runtime-permissions.md} | 2 -- .../snapshot-size.md} | 2 -- .../watermarks-and-overlays.md} | 2 -- .../contact.md} | 2 -- .../contributing.md} | 2 -- .../2018-12-21-donate.md => _extra/donate.md} | 2 -- .../v1-migration-guide.md} | 2 -- docs/_includes/footer.html | 2 +- docs/_includes/navigation.html | 30 +++++------------ docs/_layouts/landing.html | 11 ++++--- docs/_posts/.gitkeep | 0 docs/{_posts/2019-12-04-home.md => home.md} | 0 29 files changed, 30 insertions(+), 92 deletions(-) rename docs/{_posts/2018-12-20-changelog.md => _about/changelog.md} (99%) rename docs/{_posts/2018-12-20-getting-started.md => _about/getting-started.md} (99%) rename docs/{_posts/2018-12-20-install.md => _about/install.md} (88%) rename docs/{_posts/2018-12-20-camera-events.md => _docs/camera-events.md} (98%) rename docs/{_posts/2018-12-20-capture-size.md => _docs/capture-size.md} (99%) rename docs/{_posts/2018-12-20-capturing-media.md => _docs/capturing-media.md} (98%) rename docs/{_posts/2018-12-20-controls.md => _docs/controls.md} (99%) rename docs/{_posts/2018-12-20-debugging.md => _docs/debugging.md} (92%) rename docs/{_posts/2018-12-20-error-handling.md => _docs/error-handling.md} (97%) rename docs/{_posts/2019-08-06-filters.md => _docs/filters.md} (98%) rename docs/{_posts/2018-12-20-frame-processing.md => _docs/frame-processing.md} (99%) rename docs/{_posts/2018-12-20-gestures.md => _docs/gestures.md} (98%) rename docs/{_posts/2019-09-04-metering.md => _docs/metering.md} (98%) rename docs/{_posts/2018-12-20-more-features.md => _docs/more-features.md} (98%) rename docs/{_posts/2018-12-20-preview-size.md => _docs/preview-size.md} (98%) rename docs/{_posts/2018-12-20-previews.md => _docs/previews.md} (98%) rename docs/{_posts/2018-12-20-runtime-permissions.md => _docs/runtime-permissions.md} (96%) rename docs/{_posts/2019-02-24-snapshot-size.md => _docs/snapshot-size.md} (96%) rename docs/{_posts/2019-07-14-watermarks-and-overlays.md => _docs/watermarks-and-overlays.md} (98%) rename docs/{_posts/2018-12-20-contact.md => _extra/contact.md} (91%) rename docs/{_posts/2018-12-20-contributing.md => _extra/contributing.md} (97%) rename docs/{_posts/2018-12-21-donate.md => _extra/donate.md} (98%) rename docs/{_posts/2018-12-20-v1-migration-guide.md => _extra/v1-migration-guide.md} (99%) delete mode 100644 docs/_posts/.gitkeep rename docs/{_posts/2019-12-04-home.md => home.md} (100%) diff --git a/docs/_posts/2018-12-20-changelog.md b/docs/_about/changelog.md similarity index 99% rename from docs/_posts/2018-12-20-changelog.md rename to docs/_about/changelog.md index b00515c4..1e3bb8fb 100644 --- a/docs/_posts/2018-12-20-changelog.md +++ b/docs/_about/changelog.md @@ -1,8 +1,6 @@ --- layout: page title: "Changelog" -category: about -date: 2018-12-20 17:49:29 order: 3 --- diff --git a/docs/_posts/2018-12-20-getting-started.md b/docs/_about/getting-started.md similarity index 99% rename from docs/_posts/2018-12-20-getting-started.md rename to docs/_about/getting-started.md index 4c63a68b..5cd3668b 100644 --- a/docs/_posts/2018-12-20-getting-started.md +++ b/docs/_about/getting-started.md @@ -2,8 +2,6 @@ layout: page title: "Getting Started" description: "Simple guide to take your first picture" -category: about -date: 2018-12-20 17:48:58 order: 2 disqus: 1 --- diff --git a/docs/_posts/2018-12-20-install.md b/docs/_about/install.md similarity index 88% rename from docs/_posts/2018-12-20-install.md rename to docs/_about/install.md index 128a4c86..d653a721 100644 --- a/docs/_posts/2018-12-20-install.md +++ b/docs/_about/install.md @@ -2,9 +2,7 @@ layout: page title: "Install" description: "Integrate in your project" -category: about order: 1 -date: 2018-12-20 17:47:32 --- The library works on API 15+, which is the only requirement and should be met by most projects nowadays. diff --git a/docs/_config.yml b/docs/_config.yml index 85b86f6d..2abdd50e 100644 --- a/docs/_config.yml +++ b/docs/_config.yml @@ -14,13 +14,21 @@ github: [metadata] # TODO What's this? github_repo: CameraView github_version: 2.6.0 github_branch: master -donateurl: '/extra/donate' # relative URL for donations, used in footer.html baseurl: '/CameraView' # Keep as an empty string if served up at the root -sections: [ - ['about', 'Overview'], - ['docs', 'Documentation'], - ['extra', 'More'] -] +collections: + about: + name: Overview + output: true + docs: + name: Documentation + output: true + extra: + name: More + output: true +screenshots: + - 'screen1.png' + - 'screen2.png' + - 'screen3.png' # Jekyll specific stuff author: @@ -32,20 +40,7 @@ plugins: - jekyll-seo-tag # Add SEO tags permalink: /:categories/:title # Ensure permalinks have no date nor extension exclude: ['script', 'README.md'] # Exclude non-site files - highlighter: rouge # Syntax highlighting -future: true # What's this? markdown: kramdown # Use the kramdown Markdown renderer -redcarpet: - extensions: [ - 'no_intra_emphasis', - 'fenced_code_blocks', - 'autolink', - 'strikethrough', - 'superscript', - 'with_toc_data', - 'tables', - 'hardwrap' - ] kramdown: input: GFM # Use Github Flavored Markdown diff --git a/docs/_posts/2018-12-20-camera-events.md b/docs/_docs/camera-events.md similarity index 98% rename from docs/_posts/2018-12-20-camera-events.md rename to docs/_docs/camera-events.md index 1cb3e4a5..921b1676 100644 --- a/docs/_posts/2018-12-20-camera-events.md +++ b/docs/_docs/camera-events.md @@ -2,8 +2,6 @@ layout: page title: "Camera Events" description: "Dealing with the camera lifecycle and callbacks" -category: docs -date: 2018-12-20 20:02:08 order: 1 disqus: 1 --- diff --git a/docs/_posts/2018-12-20-capture-size.md b/docs/_docs/capture-size.md similarity index 99% rename from docs/_posts/2018-12-20-capture-size.md rename to docs/_docs/capture-size.md index 89929b89..3ab2673b 100644 --- a/docs/_posts/2018-12-20-capture-size.md +++ b/docs/_docs/capture-size.md @@ -2,9 +2,7 @@ layout: page title: "Capture Size" description: "Set size of output media" -category: docs order: 9 -date: 2018-12-20 22:07:22 disqus: 1 --- diff --git a/docs/_posts/2018-12-20-capturing-media.md b/docs/_docs/capturing-media.md similarity index 98% rename from docs/_posts/2018-12-20-capturing-media.md rename to docs/_docs/capturing-media.md index ba1b4376..e84b5cb0 100644 --- a/docs/_posts/2018-12-20-capturing-media.md +++ b/docs/_docs/capturing-media.md @@ -2,9 +2,7 @@ layout: page title: "Capturing Media" description: "Understanding pictures, videos and the snapshot concept" -category: docs order: 3 -date: 2018-12-20 20:53:17 disqus: 1 --- diff --git a/docs/_posts/2018-12-20-controls.md b/docs/_docs/controls.md similarity index 99% rename from docs/_posts/2018-12-20-controls.md rename to docs/_docs/controls.md index 2949c12e..1321bce8 100644 --- a/docs/_posts/2018-12-20-controls.md +++ b/docs/_docs/controls.md @@ -2,9 +2,7 @@ layout: page title: "Controls" description: "Configuring output parameters and capture options" -category: docs order: 2 -date: 2018-12-20 21:08:53 disqus: 1 --- diff --git a/docs/_posts/2018-12-20-debugging.md b/docs/_docs/debugging.md similarity index 92% rename from docs/_posts/2018-12-20-debugging.md rename to docs/_docs/debugging.md index 0fa288bf..1861dfa6 100644 --- a/docs/_posts/2018-12-20-debugging.md +++ b/docs/_docs/debugging.md @@ -1,9 +1,7 @@ --- layout: page title: "Debugging" -category: docs order: 15 -date: 2018-12-20 20:02:38 disqus: 1 --- diff --git a/docs/_posts/2018-12-20-error-handling.md b/docs/_docs/error-handling.md similarity index 97% rename from docs/_posts/2018-12-20-error-handling.md rename to docs/_docs/error-handling.md index b1a3fcc3..b1f44624 100644 --- a/docs/_posts/2018-12-20-error-handling.md +++ b/docs/_docs/error-handling.md @@ -1,9 +1,7 @@ --- layout: page title: "Error Handling" -category: docs order: 14 -date: 2018-12-20 20:02:31 disqus: 1 --- diff --git a/docs/_posts/2019-08-06-filters.md b/docs/_docs/filters.md similarity index 98% rename from docs/_posts/2019-08-06-filters.md rename to docs/_docs/filters.md index e7be99f2..6842b78a 100644 --- a/docs/_posts/2019-08-06-filters.md +++ b/docs/_docs/filters.md @@ -2,9 +2,7 @@ layout: page title: "Real-time Filters" description: "Apply filters to preview and snapshots" -category: docs order: 12 -date: 2019-08-06 17:10:17 disqus: 1 --- diff --git a/docs/_posts/2018-12-20-frame-processing.md b/docs/_docs/frame-processing.md similarity index 99% rename from docs/_posts/2018-12-20-frame-processing.md rename to docs/_docs/frame-processing.md index 0a424dce..8553a4bf 100644 --- a/docs/_posts/2018-12-20-frame-processing.md +++ b/docs/_docs/frame-processing.md @@ -2,9 +2,7 @@ layout: page title: "Frame Processing" description: "Process each frame in real time" -category: docs order: 6 -date: 2018-12-20 20:45:42 disqus: 1 --- diff --git a/docs/_posts/2018-12-20-gestures.md b/docs/_docs/gestures.md similarity index 98% rename from docs/_posts/2018-12-20-gestures.md rename to docs/_docs/gestures.md index 67d7865c..961367d6 100644 --- a/docs/_posts/2018-12-20-gestures.md +++ b/docs/_docs/gestures.md @@ -2,9 +2,7 @@ layout: page title: "Gestures" description: "Gestures control" -category: docs order: 5 -date: 2018-12-20 20:49:35 disqus: 1 --- diff --git a/docs/_posts/2019-09-04-metering.md b/docs/_docs/metering.md similarity index 98% rename from docs/_posts/2019-09-04-metering.md rename to docs/_docs/metering.md index f0a2ce6f..06d2faa3 100644 --- a/docs/_posts/2019-09-04-metering.md +++ b/docs/_docs/metering.md @@ -2,9 +2,7 @@ layout: page title: "Metering" description: "Exposure and metering controls" -category: docs order: 4 -date: 2019-09-04 19:39:03 disqus: 1 --- diff --git a/docs/_posts/2018-12-20-more-features.md b/docs/_docs/more-features.md similarity index 98% rename from docs/_posts/2018-12-20-more-features.md rename to docs/_docs/more-features.md index e088a09f..87db14dd 100644 --- a/docs/_posts/2018-12-20-more-features.md +++ b/docs/_docs/more-features.md @@ -2,9 +2,7 @@ layout: page title: "More features" description: "Undocumented features & more" -category: docs order: 16 -date: 2018-12-20 20:41:20 disqus: 1 --- diff --git a/docs/_posts/2018-12-20-preview-size.md b/docs/_docs/preview-size.md similarity index 98% rename from docs/_posts/2018-12-20-preview-size.md rename to docs/_docs/preview-size.md index ae2abf85..e24eec98 100644 --- a/docs/_posts/2018-12-20-preview-size.md +++ b/docs/_docs/preview-size.md @@ -1,10 +1,8 @@ --- layout: page title: "Preview Size" -description: "Measuring behavior" category: docs order: 8 -date: 2018-12-20 22:07:17 disqus: 1 --- diff --git a/docs/_posts/2018-12-20-previews.md b/docs/_docs/previews.md similarity index 98% rename from docs/_posts/2018-12-20-previews.md rename to docs/_docs/previews.md index 7f4b2f75..c215c2cb 100644 --- a/docs/_posts/2018-12-20-previews.md +++ b/docs/_docs/previews.md @@ -2,9 +2,7 @@ layout: page title: "Engine and Previews" description: "Camera engine and preview implementations" -category: docs order: 7 -date: 2018-12-20 21:58:16 disqus: 1 --- diff --git a/docs/_posts/2018-12-20-runtime-permissions.md b/docs/_docs/runtime-permissions.md similarity index 96% rename from docs/_posts/2018-12-20-runtime-permissions.md rename to docs/_docs/runtime-permissions.md index 3f559a1c..8db0108b 100644 --- a/docs/_posts/2018-12-20-runtime-permissions.md +++ b/docs/_docs/runtime-permissions.md @@ -2,9 +2,7 @@ layout: page title: "Runtime Permissions" description: "Permissions and Manifest setup" -category: docs order: 13 -date: 2018-12-20 20:03:03 disqus: 1 --- diff --git a/docs/_posts/2019-02-24-snapshot-size.md b/docs/_docs/snapshot-size.md similarity index 96% rename from docs/_posts/2019-02-24-snapshot-size.md rename to docs/_docs/snapshot-size.md index 81711d3c..83cde6ce 100644 --- a/docs/_posts/2019-02-24-snapshot-size.md +++ b/docs/_docs/snapshot-size.md @@ -2,9 +2,7 @@ layout: page title: "Snapshot Size" description: "Sizing the snapshots output" -category: docs order: 10 -date: 2019-02-24 17:36:39 disqus: 1 --- diff --git a/docs/_posts/2019-07-14-watermarks-and-overlays.md b/docs/_docs/watermarks-and-overlays.md similarity index 98% rename from docs/_posts/2019-07-14-watermarks-and-overlays.md rename to docs/_docs/watermarks-and-overlays.md index c96cb844..a3a117d0 100644 --- a/docs/_posts/2019-07-14-watermarks-and-overlays.md +++ b/docs/_docs/watermarks-and-overlays.md @@ -2,9 +2,7 @@ layout: page title: "Watermarks and Overlays" description: "Static and animated overlays" -category: docs order: 11 -date: 2019-07-14 20:14:31 disqus: 1 --- diff --git a/docs/_posts/2018-12-20-contact.md b/docs/_extra/contact.md similarity index 91% rename from docs/_posts/2018-12-20-contact.md rename to docs/_extra/contact.md index 657be027..54852479 100644 --- a/docs/_posts/2018-12-20-contact.md +++ b/docs/_extra/contact.md @@ -1,8 +1,6 @@ --- layout: page title: "Contact" -category: extra -date: 2018-12-20 19:47:10 order: 4 --- diff --git a/docs/_posts/2018-12-20-contributing.md b/docs/_extra/contributing.md similarity index 97% rename from docs/_posts/2018-12-20-contributing.md rename to docs/_extra/contributing.md index f9c67365..db2cf651 100644 --- a/docs/_posts/2018-12-20-contributing.md +++ b/docs/_extra/contributing.md @@ -1,8 +1,6 @@ --- layout: page title: "Contributing & License" -category: extra -date: 2018-12-20 19:28:45 order: 2 --- diff --git a/docs/_posts/2018-12-21-donate.md b/docs/_extra/donate.md similarity index 98% rename from docs/_posts/2018-12-21-donate.md rename to docs/_extra/donate.md index a297340a..abef90fc 100644 --- a/docs/_posts/2018-12-21-donate.md +++ b/docs/_extra/donate.md @@ -1,8 +1,6 @@ --- layout: page title: "Donate" -category: extra -date: 2018-12-21 13:51:39 order: 3 --- diff --git a/docs/_posts/2018-12-20-v1-migration-guide.md b/docs/_extra/v1-migration-guide.md similarity index 99% rename from docs/_posts/2018-12-20-v1-migration-guide.md rename to docs/_extra/v1-migration-guide.md index 2e23005b..da32dffa 100644 --- a/docs/_posts/2018-12-20-v1-migration-guide.md +++ b/docs/_extra/v1-migration-guide.md @@ -2,8 +2,6 @@ layout: page title: "v1 Migration Guide" description: "Breaking Changes & new concepts" -category: extra -date: 2018-12-20 19:01:55 order: 1 disqus: 1 --- diff --git a/docs/_includes/footer.html b/docs/_includes/footer.html index e39cbdf8..be732e0b 100644 --- a/docs/_includes/footer.html +++ b/docs/_includes/footer.html @@ -1,4 +1,4 @@ diff --git a/docs/_includes/navigation.html b/docs/_includes/navigation.html index 800fd61f..366fa27e 100644 --- a/docs/_includes/navigation.html +++ b/docs/_includes/navigation.html @@ -1,17 +1,18 @@ diff --git a/docs/_layouts/landing.html b/docs/_layouts/landing.html index 710878ef..130ce1fa 100644 --- a/docs/_layouts/landing.html +++ b/docs/_layouts/landing.html @@ -17,13 +17,16 @@ Documentation Changelog GitHub - Support + Support
-
Screenshot 1
-
Screenshot 2
-
Screenshot 3
+ {% assign col = 12 | divided_by: site.screenshots.size %} + {% for screenshot in site.screenshots %} +
+ Screenshot +
+ {% endfor %}
diff --git a/docs/_posts/.gitkeep b/docs/_posts/.gitkeep deleted file mode 100644 index e69de29b..00000000 diff --git a/docs/_posts/2019-12-04-home.md b/docs/home.md similarity index 100% rename from docs/_posts/2019-12-04-home.md rename to docs/home.md