Commit graph

256 commits

Author SHA1 Message Date
Vincent Prouillet 18bef00671 Rename taxonomies paginate and error on unknown ones 2018-07-16 18:14:48 +02:00
Vincent Prouillet 1ae0702494
Custom taxonomies (#330) 2018-07-16 10:54:05 +02:00
Daniel Sockwell b563142fc0 Add index page section to documentation (#331)
* Add `index page` section to documentation

The current documentation does not describe how to create a index page.
I initially found this confusing, because I expected an index page to be
a **page** rather than a section.  Thus, I tried to access the page
content with `{{ page.content }}` and was very frustrated when I could
not.

This addition clarifies that the index page is **always** a section,
even if it does not have any sub-pages.  This should also help people
who intend to use Gutenberg to build stand-alone webpages, rather than
blogs.
2018-07-16 08:49:26 +02:00
Daniel Sockwell ae0ade94f6 Render live demo link for themes if there is one 2018-07-16 08:47:04 +02:00
Daniel Sockwell 9dd206d925 Edit docs to clarify role of static folder (#329) 2018-07-14 09:07:36 +02:00
Daniel Sockwell 1431df623f Edit docs to clarify RSS process
Add details to the templates/RSS page to clarify that the `rss.xml`
page is only generated if the `generate_rss = true` variable is set
in the site's `config.toml` page.  This information is already present
in other parts of the documentation, but is not present in the RSS page,
which could be confusing.
2018-07-08 11:21:24 -04:00
Vincent Prouillet 735bb38bd7 Update docs for 404 and enable preserve-order of tera 2018-07-05 17:43:48 +02:00
Vincent Prouillet d47ba4aff0 Rebasing + tweaks 2018-06-25 19:13:21 +02:00
Vojtech Kral 17de3c9a97 imageproc: Rename _resized_images as _processed_images 2018-06-25 18:09:45 +02:00
Vojtech Kral 3e4aa82ecc imageproc: Use DefaultHasher from stdlib instead of twox-hash 2018-06-25 18:09:45 +02:00
Vojtech Kral a89768dab0 Remove page.images 2018-06-25 18:09:03 +02:00
Vincent Prouillet 8e8cdfeb7f Add year, month and day to page context with a date 2018-06-25 18:06:25 +02:00
Vojtech Kral 77bc526008 imageproc: Fix naming, cleanup 2018-06-25 18:05:49 +02:00
Vojtech Kral 7c8d39fe9c Docs for resize_image() 2018-06-25 18:05:04 +02:00
Vojtech Kral 6662014e55 Add image resizing support #225 2018-06-25 18:05:04 +02:00
Vincent Prouillet 3eb571fdbf Trim left every line of a shortcode to avoid the accidental markdown codeblock 2018-06-25 18:04:00 +02:00
Vincent Prouillet d334b1cf46 More shortcode docs update 2018-06-25 18:03:20 +02:00
Vincent Prouillet b120754862 Update shortcode parsing and docs 2018-06-25 18:02:21 +02:00
Clar Charr da3b0fcf0e Use proper Unicode word count; fixes #304 2018-06-25 18:02:07 +02:00
James Munns 3694c43d3a Update documentation regarding aliases 2018-06-25 18:02:07 +02:00
Vincent Prouillet 165b06133a
Merge pull request #281 from maccoda/master
Theme deployment
2018-04-10 11:07:32 +02:00
Alexandru Scvortov 042765c129 obfuscate <!-- more --> in docs so that it doesn't get replaced 2018-04-09 22:23:27 +01:00
Dylan Maccora a56ab5aa56 Theme deployment 2018-04-08 09:04:44 +10:00
Isaac Andrade f9186118a0 Fix typo. 2018-04-03 10:24:53 -06:00
Isaac Andrade 486c979761 Fix documentation typos and minor changes:
- Fix some typos
- Some small changes to documentation to make it more clear
- Change the themes list from text to links
2018-04-01 18:33:59 -06:00
Vincent Prouillet 789a6408fb
Merge pull request #251 from Keats/next
Next version
2018-03-29 18:03:41 +02:00
Vincent Prouillet e40e97711f Some more bits about continue_reading anchor 2018-03-28 17:01:14 +02:00
Tim DuBois c8dfc5156a
Change naming convention 2018-03-27 07:38:04 +02:00
Tim DuBois 46115334c8
Documentation 2018-03-25 13:17:03 +02:00
Erich Gubler 72d50eed7f
Sass docs: try replacing // comments with # comments when they don't indicate output paths, try to resolve single-quote issue 2018-03-23 08:52:05 -06:00
Erich Gubler b38a504094
Update _index.md 2018-03-22 15:47:34 -06:00
Erich Gubler 110e846fbe
Docs: add an entry for Sass processing in the main Content section 2018-03-22 15:46:40 -06:00
Vincent Prouillet 73ddbf7152 Write some docs 2018-03-21 16:18:24 +01:00
Vincent Prouillet 6100a430c4 Design tweaks on docs 2018-03-21 15:25:25 +01:00
Vincent Prouillet b0363298f5 Search is working now 2018-03-20 21:27:33 +01:00
Vincent Prouillet ddf8970ad8 [WIP] Search 2018-03-20 18:43:30 +01:00
Vincent Prouillet 43db3a43ff Do not require themes to have a static folder 2018-03-18 09:34:37 +01:00
Vincent Prouillet 00729581f9 Break sorting ties by a-z ordering
Closes #259
2018-03-17 18:08:02 +01:00
Vincent Prouillet 3a2dab5974 Sort sitemap elements by permalink
Closes #257
2018-03-17 14:34:02 +01:00
Vincent Prouillet 1d81bbcfd7 Add small blurb about pagination activation 2018-03-17 13:58:32 +01:00
Adrien "pandark" Pachkoff 43bba8cbdb Remove quote around (empty) date in the example
Dates must not be surrounded by quotes.
2018-03-17 05:17:41 +01:00
Vincent Prouillet 2eacb8247b Fix config CLI option
Closes #254
2018-03-16 19:11:12 +01:00
Vincent Prouillet fcd6cbcd32 Add some mobile css for themes 2018-03-05 18:27:59 +01:00
Vincent Prouillet c0ea30e2e1 Update themes & design list 2018-03-05 18:21:53 +01:00
Vincent Prouillet f93fba9563 Update dependencies 2018-03-05 18:12:28 +01:00
Vincent Prouillet 217738d0c8 Update list of themes 2018-03-01 10:37:35 +01:00
Vincent Prouillet f8b0720e39
Merge pull request #219 from Keats/docs-update
Docs update
2018-03-01 09:43:44 +01:00
Vincent Prouillet af82a280f1 Fix link 2018-02-28 20:46:41 +01:00
Vincent Prouillet 6c09c8ba8b Slight tweak on theme docs 2018-02-28 20:44:30 +01:00
Vincent Prouillet 6a712969d4 Remove theme list from docs 2018-02-28 19:49:13 +01:00
Philip Daniels 3e1221064b Filter ignored content in page.rs.
* Add ignored_content to the Config structure.
* Use the GlobSet crate to parse the glob patterns into a matcher, which
  is created once at program initialization. If there are no patterns in
  ignored_content, an empty globber is created, which excludes no files.
  This is consistent with the existing behaviour of Gutenberg, before
  this feature was added.
* Bail if there are any errors in the glob patterns.
* Add a call to the globber in page.rs to actually do the filtering.
* Update documentation.

A note on the Config structure
------------------------------
* I had to remove the PartialEq derive from the Config structure as it
  does not work for the GlobSet type. No harm is done, Config does not
  need to be PartialEq anyway, since there is no need to sort Configs.
* The implementation follows the pattern of the existing config settings
  in that it uses an Option<...>. This would appear unnecessary, in that
  an empty vec could be used as the default, but it appears to be needed
  by the TOML parsing. A better approach would be to use a separate
  SerializableConfig and map to/from a Config struct. This would also
  allow the elimination of most, if not all, of the other Options in
  the Config structure, but that ought to be another PR.
2018-02-25 15:15:51 +00:00
Vincent Prouillet 9e5c34df66 WIP theme site 2018-02-23 18:05:46 +01:00
Vincent Prouillet b966a52dd1 Add credits to deploy github page 2018-02-22 19:03:00 +01:00
Vincent Prouillet ec35d72b6f Add some deployment docs 2018-02-22 19:03:00 +01:00
Vincent Prouillet f7cacba3f0 Update deps and changelog 2018-02-02 17:35:03 +01:00
Vincent Prouillet 54841b19bb
Merge pull request #220 from Keats/markdown-inline
Markdown inline
2018-02-02 17:29:16 +01:00
Andrew Zah f5ced05926 Separate interface and base url for gutenberg serve (#223)
Separate interface and base_url for serve

You can now have a different base_url and listening interface.
The `gutenberg serve` cmd now accepts `-u`/`--base-url`, but it defaults to `127.0.0.1`.
2018-02-02 17:18:07 +01:00
Vincent Prouillet 16f658c70c Move test_site and turn rebuild.rs into a component 2018-01-29 18:40:12 +01:00
Vincent Prouillet 29ce510aa3 Add inline option of markdown filter
Fix #197
2018-01-26 16:22:38 +01:00
Vincent Prouillet c165c17c2f
Merge pull request #175 from Keats/next
Next version
2018-01-25 14:33:53 +01:00
Sven-Hendrik Haase 462365642d
Proper Arch Linux spelling
It's either Arch Linux or archlinux but never Archlinux or ArchLinux.
2018-01-23 12:48:18 +01:00
Vincent Prouillet f3b1553a26 Update docs about trans 2018-01-16 13:57:31 +01:00
Peter Reijnders ec9375422d added reference to materialize theme and 'who is using' 2018-01-15 17:59:17 +01:00
Vincent Prouillet ade179ec15 Mention lack of quotes for dates in docs 2018-01-14 18:08:04 +01:00
Peter Reijnders 3ffcfda1a0 added remark concerning include-not-in-templates (#209)
* added remark concerning include-not-in-templates

Closes https://github.com/Keats/gutenberg/issues/208
2018-01-12 17:55:39 +01:00
Vincent Prouillet 1254d0a71d Update syntaxes
And add Prolog (closes #170)
2018-01-02 18:14:26 +01:00
Vincent Prouillet 14edd2b875 Add output-dir option to build & serve
From #191
2017-12-29 19:26:17 +01:00
Vincent Prouillet 638d4d7bc3 Mention index.html for index page in docs 2017-11-26 11:34:18 +01:00
Vincent Prouillet 021c99c5f0 Fix tests and add taxonomies to changelog 2017-11-26 10:07:34 +01:00
Vincent Prouillet 322d2f30fb Add get_taxonomy_url global_fn
And fix bug with taxonomies urls
2017-11-26 10:07:34 +01:00
Carson Page 8759323a16 Add trailing_slash opt. to get_url (#173)
* Added inital trailing_slash impl

* Added simple test

* Updated docs website to use trailing_slash option

* Updated documentation to reflect new trailing_slash option

* Added combined cachebust and trailing_slash test
2017-11-26 10:07:34 +01:00
Thomas Vincent 889cb6bcf8
Typo fix 2017-11-17 22:40:41 +01:00
Vincent Prouillet c0c187c955 Mention config for taxonomies docs 2017-11-16 20:50:09 +01:00
Vincent Prouillet 3040f00de2 Add docs for taxonomies
Close #167
2017-11-14 17:55:50 +01:00
Carson Page 193d0184f0 Added installation method for Void Linux 2017-11-08 20:39:09 -06:00
Vincent Prouillet b4c8b5912c Fix typo in section front-matter doc 2017-11-03 10:33:09 +01:00
Vincent Prouillet 3f9d39481d Add brew installation & contributing doc 2017-11-01 16:31:58 +01:00
Vincent Prouillet 560e467694 Add page.draft to docs 2017-11-01 14:53:28 +01:00
Vincent Prouillet 791fbe685b Add page and section components 2017-10-31 16:41:31 +01:00
Vincent Prouillet bfdfe3bba3 Properly parse shortcode arg value types 2017-10-26 17:03:26 +02:00
Vincent Prouillet be2f01b5bc Some addition to themes creation 2017-10-24 19:32:26 +02:00
Vincent Prouillet 9d0f84051d Add test for unterminated shortcode# 2017-10-23 15:54:32 +02:00
Vincent Prouillet 7d7efdd6ea Handle markdown parser potentially splitting shortcodes 2017-10-23 14:18:05 +02:00
King Claudy a6919d4b6d Docs : Fix typo in Templates/Overview 2017-10-22 13:16:25 +02:00
Quentin Bourgeois 97a439b2fe <documentation/page.md: Fix a typo into page.md doc> 2017-10-21 15:00:47 +00:00
Vincent Prouillet 7cf120d0da Add scoop install instructions 2017-10-21 09:48:29 +02:00
Vincent Prouillet ccaefed304 Fix typo in theme docs 2017-10-20 12:35:23 +02:00
Vincent Prouillet 5318c9bc4c id -> url in gist shortcode doc 2017-10-20 08:47:27 +02:00
Baptiste Fontaine 31f6a923eb documentation: fix a duplicated “the” 2017-10-19 23:30:32 +02:00
Vincent Prouillet 5b3d17cd2c Fix tera link 2017-10-19 17:07:55 +02:00
Vincent Prouillet f2a5c959c1 Redirect on templates and themes sections 2017-10-19 17:06:31 +02:00
Justus Perlwitz 7d13489555 Fix tera netlify link 2017-10-19 16:04:47 +02:00
Vincent Prouillet bdcad38310 Finishing up site (#131)
* Finishing up site

* Make site a bit responsive

* Fix menu responsiveness

* Remove Fira Sans and revamp a bit text

* Update list of syntax and change output of syntax

* Add Rust mention

* Some doc tweaks

* Correct capitalization for GitHub

Correct capitalization for GitHub

* Some CSS tweaks

* More css tweaks + favicon

* Add link to my site
2017-10-19 13:48:50 +02:00
Christian Oliff 5be8983f4a capitalization and spacing fix 2017-10-19 18:23:49 +09:00
Christian Oliff 9b9c2c4835 MacOS is one word 2017-10-19 18:22:00 +09:00
Vincent Prouillet 80aae52ce4 Use netlify as base url for site 2017-10-16 17:51:48 +02:00
Vincent Prouillet f6dac93ffc Update installation notes 2017-10-16 15:22:47 +02:00
Vincent Prouillet 73797efe90 Add a base-url flag to the build command 2017-10-05 10:56:13 +09:00
Vincent Prouillet f26b9d53bd url -> path in page front-matter 2017-10-04 09:35:37 +09:00
Vincent Prouillet c348648b02 Some design work on docs 2017-10-04 00:21:18 +09:00
Vincent Prouillet 6c8c27aa55 Redirect the documentation section index 2017-10-02 21:22:56 +09:00
Vincent Prouillet 952b6679ce Change taxonomies to be sorted a-z and add permalinks 2017-10-01 14:04:30 +09:00
Vincent Prouillet 57b87aa50a Add more docs pages 2017-10-01 12:51:43 +09:00
Vincent Prouillet dee1dbe667 Working on site
And some tweaks as I write the docs
2017-09-29 15:37:58 +09:00
Vincent Prouillet bad1378485 WIP docs 2017-09-12 16:13:26 +09:00
Vincent Prouillet 52fa0c3023 WIP site 2017-09-08 18:59:51 +09:00