ux: CHANGE change 'feeds' to 'sections' - BREAKING - short guide in release notes
This commit is contained in:
parent
98ab0ab419
commit
a99d1db1cb
4 changed files with 59 additions and 59 deletions
24
README.md
24
README.md
|
|
@ -23,8 +23,8 @@ Show cases:
|
|||
- long- and short form content
|
||||
- pages
|
||||
- static files
|
||||
- separate feeds (used for categories, tagging, etc) `/feed/{tag}`
|
||||
- exclusion of feeds from main feed (drafts or system notes)
|
||||
- separate sections (used for categories, tagging, etc) `/section/{tag}`
|
||||
- exclusion of sections from main index (drafts or system notes)
|
||||
- HTML anchors for headers
|
||||
- list random posts at the bottom
|
||||
- optional RSS feeds
|
||||
|
|
@ -47,33 +47,33 @@ Put markdown file into `items` dir. **Important naming convention**:
|
|||
2025-10-05_short_quick-update_draft.md
|
||||
```
|
||||
|
||||
Format: `YYYY-MM-DD_type_slug[_feed].md`
|
||||
Format: `YYYY-MM-DD_type_slug[_section].md`
|
||||
|
||||
- `2025-10-03` - date of the article
|
||||
- `_long_` - type of content: `long`, `short`, or `page`
|
||||
- `building-a-static-site-generator` - slug/path for the URL
|
||||
- `_draft` (optional) - feed tag for categorization
|
||||
- `_draft` (optional) - section tag for categorization
|
||||
|
||||
The first `#` header is the title of the article - no frontmatter needed.
|
||||
|
||||
**Types of content**:
|
||||
- `long` - only title with link to articles will be displayed in feed
|
||||
- `long` - only title with link to articles will be displayed in the main index
|
||||
- `short` - title and all content will be displayed
|
||||
- `page` - won't be displayed in feed at all
|
||||
- `page` - won't be displayed in the main index at all
|
||||
|
||||
### Feeds
|
||||
### Sections
|
||||
|
||||
Posts can be tagged with an optional feed category (e.g., `_python`, `_webdev`). Posts with feed tags:
|
||||
Posts can be tagged with an optional section (e.g., `_python`, `_webdev`). Posts with section tags:
|
||||
- Appear on the main page (unless excluded in config)
|
||||
- Have their own feed page at `/feed/{tag}/`
|
||||
- Have their own section page at `/section/{tag}/`
|
||||
|
||||
**Configuration in `config.py`:**
|
||||
```python
|
||||
# Exclude specific feeds from main page (they'll still have /feed/name/ pages)
|
||||
EXCLUDE_FEEDS_FROM_MAIN = ['draft', 'private']
|
||||
# Exclude specific sections from main page (they'll still have /section/name/ pages)
|
||||
EXCLUDE_SECTIONS_FROM_MAIN = ['draft', 'private']
|
||||
```
|
||||
|
||||
This is useful for draft posts or topic-specific content you want separated from the main feed.
|
||||
This is useful for draft posts or topic-specific content you want separated from the main index.
|
||||
|
||||
---
|
||||
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue