Update to use metalsmith-in-place #320
Conversation
Update package dependencies. Remove index.js to generate site (obsolete) and do so with `metalsmith` CLI and `metalsmith.json`. Update `src` to use Markdown (not HTML source), and update links to link to the generated `*.html` files. Make the links relative so you can preview file: pages in the browser
|
Cool, thanks for the PR 😊! I'm thinking that it might be good if we just delete the examples altogether actually. Keeping these both these examples as well as the wikis on layouts and in-place up-to-date seems prone to errors. I personally think it would be better, and less confusing to newcomers to just have the examples in one place. What do you think @Ajedi32 ? |
|
As a user, I prefer actual git repos and real source code over wikis examples. The wiki examples are harder to use, as one must copy/paste more commands (multiple |
|
As @DavidBiesack says, having examples in git that you can easily clone and run is valuable. They do have a tendency to get out of date though, which makes them much less useful than they otherwise could be. I previously proposed #208 as a possible solution to that problem. Perhaps the Metalsmith core repo isn't the best place for these sort of projects. It'd be nice if we could move those a place more focused on documentation, but I'm not really sure where. |
I think it’s also complicated because the examples use plugins which aren’t a part of this repo.
I think that that’s better. Currently documentation is too fragmented in my opinion. I’d completely forgotten that these examples were in the core repo for example |
Update package dependencies. Remove index.js to generate site (obsolete)
and do so with
metalsmithCLI andmetalsmith.json.Update
srcto use Markdown (not HTML source),and update links to link to the generated
*.htmlfiles.Make the links relative so you can preview file: pages in the browser