Readme unclear #91
Labels
Comments
|
There have been a few changes to that section of the README, appreciate the ping! It needed some cleanup. As a follow up it might be helpful to read through some of the commentary on 11ty/eleventy#746 Personally, I’d rather folks use the |
bennypowers
pushed a commit
to RedHat-Israel/RedHat-Israel.github.io
that referenced
this issue
Jul 18, 2022
Initial commit. Initial commit Renames url filter to `url` Instructions. Add link to eleventy Implementation Notes Reorder docs Use <link> to refer to the Atom feed start of eleventy-base-blog that pairs with 0.2.8 Fixes #3 Changes eleventy pkg min Adds a syntax highlighter example to templates for #3 Metadata edit to docs Trying out that autodeploy Logo, what logo Try again. One more. Trying to run eleventy on commit Now we’re trying to get it to run eleventy. Switch to plain syntax Switch to npx Try to run from node_modules. New tries on the local install Try a `before_script` Deployyyyy Use script Add subdir for gh-pages Fix for subdir links. Build status and demo links to readme Remove home from nav Try prismjs highlighter Upgrades to 0.2.9 for new url filter. Upgrades to eleventy v0.2.10 Fixes #5 Fixes #4, point feed links directly to file to avoid web server specific stuff. Bump to 2.0 Adds an .nvmrc for netlify deploys. Move from atom.xml to feed.xml for tech agnostic-ish filename. Change default config to use pathPrefix: "/" and then use `--pathprefix="/eleventy-base-blog/` for GitHub deploy command. Requires Eleventy v0.2.11 v3.0.0 Netlify defaults. Adds Netlify stuff to the readme. Add link back to repo from demo pages. Moves warning message to _includes/base.njk, adds a home link to posts Emoji was bad. Refactors Liquid syntax highlighters to add line highlights. Usage (ranges are space separated): {% highlight js 1,4-6 %} One range Adds `highlight-line-active` to lines 1,4,5,6 {% highlight js 3-4 -1 %} Two ranges (add/remove), remove is N/A Adds `highlight-line-add` to lines 3,4 {% highlight js -1 3-4 %} Two ranges (add/remove), add is N/A Adds `highlight-line-remove` to lines 3,4 {% highlight js 3-4 5,8-10 %} Two ranges, both are used Adds `highlight-line-add` to lines 3-4 Adds `highlight-line-remove` to lines 5,8,9,10 Fixes #6 v3.0.1 superfluous callback Fixes urls in feed. Try the plain highlighter Switch to debug for netlify deploy Separate files for syntax highlighters Ugh, case sensitivity filename issue on Mac OS Show off the syntax line highlights Adds editorconfig for my own sanity. Move all src JS into external plugins installed through NPM: @11ty/eleventy-plugin-rss @11ty/eleventy-plugin-syntaxhighlight Updated license name simplified npm script names v4.0.0 Updates for 0.2.14 Dependency updates v4.0.1 Use new markdown syntax highlighter b/c it’s cool, v4.0.2 adding img dir to align with default eleventy.js settings and avoid error Update deps Adds tag pages example Use url filter for proper urls on github pages _includes/base.njk —> _includes/layouts/base.njk Updated the file path of `base.njk` Adds markdown-it-anchor plugin Upgrades to 0.4.0 and adds tag pages Standardize on content and not templateContent (per docs) Simplify collection filtering using `startsWith` Adds 404 page. Adds a /tags/ to list all valid tags Add `reversed` attribute to posts list Without CSS, the last post will be number 1. In browsers other than IE and Edge (where it's currently under consideration), the `reversed` attribute will match the effect of the CSS counter. I like putting the attribute first so it's clear that it's a particular kind of "ordered list: reversed." Set default text and background colours Some elements in the design have text colour without background colour. Setting a global background colour should be enough with current text colours. I wonder however if `var(--white)` is really necessary, instead of `white`. Typo gray != grey Workaround for #15 Use Set instead of object in `getTagList` Update getTagList.js Fix set usage Fix #18. Fix a typo Add archives page Blogs commonly only display the latest `n` blog posts on the home page, while showing the full list on a separate archive page. This change implements that. Add sitemap.xml Add code snippet with 2 consecutive new lines This demonstrates the issue that 11ty/eleventy-plugin-syntaxhighlight#5 fixes, and could serve as kind of a regression test for the fix. :) Use <time> where applicable Whitespace Adds liquid templates to templateFormats Whitespace, adds fourth sample post Refactored latest posts and with a correct sort. Uses dates on posts rather than file creation dates (unreliable). Upgrades dependencies to latest. Fix href on github pages Same URL pattern for relative paths that I have seen elsewhere Using deep data merge (post tag is inherited from posts/posts.json) and updates to use 0.7.0. Bump version Add link to quick tip in 404 page. Also a link to home. Eleventy v0.7.1 Adds 11ty/eleventy#386 to default eleventy-base-blog config readme update to include how to host using local webserver for development purposes xml date fix Updates dependencies. Use new eleventyExcludeFromCollections feature in 0.8.0: https://www.11ty.io/docs/collections/#option%3A-exclude-content-from-collections Updates to 0.8.1 Updates Eleventy dependency. Create FUNDING.yml Dependency update Updates to Eleventy 0.9.0 Updates syntaxhighlight plugin Remove npx from package.json Use `eleventy-navigation` plugin for navigation menu Navigation plugin needs to work with pathprefix (update dep) Switches to use more obvious markup menu template for eleventy-navigation v5.0.1 use tagList with full filter instead of just excluding posts run browsersync in ghost mode The average user probably does not want every reader's scroll position synced to every other reader. Builds feed URL from site URL to reduce replication Add ZEIT Now one-click deployment A bit less redundant editorial :) Extra colon Fix #47 Rename the variable for #47 Upgrade dep Rogue markdown! Nicer browsersync defaults. v5.0.2 Nicer font Taken from: https://bitsofco.de/the-new-system-font-stack/ system-ui font Update to v0.10.0 Updates to 0.11.0 Bump nvmrc to 10 for netlify I tried deploying a site based on the starter to netlify and it failed due to a node mismatch. This got the build to work. Name update post rebranding Update TLD Reverse order of posts in feed * Allows feed readers to make sure they get the latest post, even of parsing is limited. Use eleventyComputed instead of renderData Avoid name clash with `tag` in HTML syntax highlighting Avoid name clash with `tag` in HTML syntax highlighting Avoid name clash with `tag` in HTML syntax highlighting bump eleventy navigation to 0.1.5 Updates navigation dependency. Add jsonfeed to metadata Add filter for HTML content Add jsonfeed template Add jsonfeed to base template use JSON.stringify for content Reuse feed backs from metadata file and adds comments about it. Reuse the `url` filter to work with path prefixes. Clean up the JSON code a bit (don’t need that extra filter) Add 'remix on glitch' link to readme Working port of this project on glitch.com I don’t think `category` is used here. Get rid of the _11ty folder—we don’t need it. Adds next and previous post links. Fixes #70 The pathPrefix url filter isn’t needed here for permalinks. Otherewise the files generate to a special folder. We want the directory output to look the same, not with hardcoded pathprefix directories. Use a newer Node Upgrade node version in travis config Update eleventy Update deps. Serve 404 page with status code 404, not 200 Signed-off-by: Anders Kaseorg <andersk@mit.edu> Add "language" value to update jsonfeed to v1.1 Add language field/bump version to 1.1 Change to more generic two letter code Read more: https://jsonfeed.org/version/1.1 changed perms of _data/metadata.json Fixes #62. Fixes #63. Missed one for #63. Change those ugly red tags. Tweaks to posts list css. Support spaces in tags in base blog. Update Eleventy version. Align tags Update markdown deps (major bump!) Update RSS plugin Add missing colon to `json.njk` Fixes malformed JSON feed output Update readme instructions for css and images The instructions should be changed to properly reflect the way css and images are handled in the configuration. At the moment the instructions reference css and png files being handled via templateFormats, but in reality they're configured to be located in special css and img directories and handled via addPassthroughCopy(). fix: add `tr` element for valid markup Signed-off-by: Jens Oliver Meiert <jens@meiert.com> fix: convert URLs in post content Signed-off-by: Jens Oliver Meiert <jens@meiert.com> We don’t need to manage this tags list in two places. Restore the 4 hundos Additional safety for head check Only for non-empty collections. Updates deps, including new major version of markdown-it-anchor. Restore old luxon to keep Node compat levels. Update to Eleventy 1.0 Removes Travis CI configuration file. Upgrade syntax highlighter to 4.0 and update example to use diff syntax Remove alias Switch devDeps to deps Clean up the commands Missed a diff syntax example Update to 1.0.1 Adds `<meta name="generator">` to eleventy-base-blog Update deps Update the Node default Add link to deployment docs Copy tweaks Use `metadata.language` for the `lang` attribute It's already `en` by default. Replace tag with eleventyNavigation in navigation instructions Top level navigation has been updated in 11ty/eleventy-base-blog@c9018fa to use `eleventyNavigation` instead of the `nav` tag. We have to update the readme file to also account for this change. Removes `nav` from filtered tag list for #100 Fix usage of `level` in the options object for `markdown-it-anchor` Update README.md Add `@11ty/` prefix to <kbd>eleventy</kbd> commands. (Per: https://www.11ty.dev/docs/usage/) FIxes #120 Introduce dark mode and add fonts to base variables update warning color too Update index.css Some variable cleanup and color changes Update dependencies Fixes 11ty/eleventy-base-blog#94 Switch to use 1.0+ slugify filter instead Fixes 11ty/eleventy-base-blog#91 Fixes 11ty/eleventy-base-blog#87 Fix 11ty/eleventy-base-blog#86 Eleventy Base Blog 7.0
dirtystylus
pushed a commit
to dirtystylus/mllty
that referenced
this issue
Nov 16, 2024
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
In the Implementation Notes section of the
README, it states:However, taking a look at
.eleventy.js, thetemplateFormatsare (cssandpngare not listed):Personally, this led to some confusion and I think some rewording would be helpful here. I think the point we'd like to get across is this:
If the above is true, and you're okay with that change, I'd love to submit a PR to make that modification. Thanks!!
The text was updated successfully, but these errors were encountered: