Comments (10)
@chrisdel101 Thanks for offering... And yes, by "features" I was just referring to basic Jekyll blog features, i.e. as explained in https://jekyllrb.com/docs/posts/. As you say, the idea is that new blog posts would be written/published using the current GitHub/PR flow as for the rest of the docs.
IMO, the minimal work to add a blog would be:
- Add a new layout template in
_layouts
for blog posts. Nothing fancy, but will be a bit different from a regular page in the site. Should still display the site menu, presumably. - Add a blog index that displays links to all the files in
_posts
along with publication date, authors, and a short excerpt for each. Perhaps highlighting the most recent post ... - Add a menu item that links to the above; Either a new top-level item to the right of "Resources" or an item in the "Resources" menu. Exact UX is TBD based on input from TC, et al.
I might be missing some other steps, but that's the general idea. Until we have some "real" blog posts, just start with a "Welcome to the Express blog" placeholder post that explains HOW to write a post and submit a PR to publish it.
Once this framework is in place, I hope folks in the TC and others will start writing posts with real content.
from expressjs.com.
So I have created the ability to add posts and display them. I've add two dummy posts to test and taken a screen shot. These won't be commited with the feature.
I've also shown what will happen when there are no posts, as I guess there will not be right after this change is made. If you were to run this now, you would see the second one.
The task now is to decide how we want them laid out, I mean on the index page above. We can have them in one long list like they are now, or group by months, or by quarter, or by topics. Any input on that?
We can also add tags to each post if you want to track them this way.
I think the layout of the posts themselves can be dictated by the authors? Since they'll be writing them in HTML or MD.
I will also add the rest of the stuff you asked for in next commit: publication date, authors, and a short excerpt for each. Can also highlighting the most recent post.
Oh, and I guess will fill in the currenrtly empty space with an explanation of how to write a post, as you suggest above too
from expressjs.com.
This is great @chrisdel101 ... Thanks for taking this on!
The task now is to decide how we want them laid out, I mean on the index page above.
I think initially, just a reverse chronological list, i.e. with the most-recent post first, followed by the one before that, and so on... That should be fine until we have more than a handful of posts, at which point we can discuss dividing them by month, quarter, or whatever, depending on how often we have posts. We just don't know yet, since we haven't had a blog before!
Each post in this list should include title, publication date, author(s), and excerpt (maybe, see below).
I think the layout of the posts themselves can be dictated by the authors? Since they'll be writing them in HTML or MD.
Yes, but it might be nice to display a list of posts/links in the left gutter (otherwise empty), without all the extra stuff (author, date, etc) to provide a kind of navigation among the blog post.. This is similar to how the API reference works. If we do this, then the blog "home page" could always show the complete most-recent post, and the links in the left gutter would link to older ones.
Alternatively, the "home page" would show the list of all the posts with short excerpts, and perhaps the most-recent one would have a longer excerpt. I think the first way is more common, but I'm open to either approach.
Otherwise, having the blog post layout the same as the current page layout seems fine to me. We do need to think about how the authors and date will be displayed... As sub-headings below the title, presumably. Otherwise, at your discretion.
Re: tags, I think that's a great idea that would be helpful in the long run, but I think we can live without it for the initial incarnation. It won't even be relevant until we have a number of posts, and as previously noted, this is so new it's hard to know if/when we'll have many...
from expressjs.com.
What type of features? I assume you just mean that blog posts would be committed by your team (or others w. your permission) as files added the blog folder. Like by developers who know how to do such things.
Meaning, you don't expect an markdown editor w. the ability to create new posts within the site itself, and authentication, etc, where hitting "submit" creates a new post.
Adding a editor and blog post capabilities is possible for me to do, but if authentication does not already exist, then anyone could post.
If I understand I assume you don't want that. So we'd just need to add a blog link to the nav and then serve any posts from the blog folder, which Jekyll does very easily.
I can handle this if you confirm this will work.
from expressjs.com.
Okay, will look into this.
from expressjs.com.
Related Issues (20)
- Debugging guide references DEBUG_FD environment variable which was removed from node debug module HOT 3
- How to set debug mode on Windows? HOT 2
- Res.Render documentation missing information. HOT 1
- How to flush a response? HOT 1
- Update 5.0 version in Migration Guide HOT 1
- Update security and performance best practices HOT 2
- Release change log page does not show the latest 2 versions HOT 4
- State minimum required version of Node.js HOT 5
- Review and Update v5.x Documentation against v4.x HOT 3
- Proposal to map out outdated translations HOT 1
- Expand CI functionality to preview changes from PR HOT 6
- Broken link / domain squatter link on homepage HOT 2
- Nav links do not reppear after resizing HOT 3
- Ideas for blog content HOT 6
- Add GH action for routine version updates
- Add GH action to update middleware READMEs
- Documentation working group HOT 4
- Dark Mode flash HOT 4
- Issue with Dark Mode: Poor Visibility of Selected Input HOT 6
Recommend Projects
-
React
A declarative, efficient, and flexible JavaScript library for building user interfaces.
-
Vue.js
🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.
-
Typescript
TypeScript is a superset of JavaScript that compiles to clean JavaScript output.
-
TensorFlow
An Open Source Machine Learning Framework for Everyone
-
Django
The Web framework for perfectionists with deadlines.
-
Laravel
A PHP framework for web artisans
-
D3
Bring data to life with SVG, Canvas and HTML. 📊📈🎉
-
Recommend Topics
-
javascript
JavaScript (JS) is a lightweight interpreted programming language with first-class functions.
-
web
Some thing interesting about web. New door for the world.
-
server
A server is a program made to process requests and deliver data to clients.
-
Machine learning
Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.
-
Visualization
Some thing interesting about visualization, use data art
-
Game
Some thing interesting about game, make everyone happy.
Recommend Org
-
Facebook
We are working to build community through open source technology. NB: members must have two-factor auth.
-
Microsoft
Open source projects and samples from Microsoft.
-
Google
Google ❤️ Open Source for everyone.
-
Alibaba
Alibaba Open Source for everyone
-
D3
Data-Driven Documents codes.
-
Tencent
China tencent open source team.
from expressjs.com.