Skip to content

Commit 135388e

Browse files
Merge pull request #71 from virtualguard101/dev
chore: modified 'publish' field as 'false' by default in note template
2 parents 453bf3b + bd75945 commit 135388e

4 files changed

Lines changed: 9 additions & 3 deletions

File tree

docs/about/changelog.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -12,6 +12,12 @@ All notable changes to this project will be documented in this file.
1212
The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.1.0/),
1313
and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
1414

15+
## 3.1.2 - 2026-04-08
16+
17+
### Changed
18+
19+
- Modified `publish` field in note frontmatter as `false` by default, to prevent notes from being published before they are ready.
20+
1521
## 3.1.1 - 2026-02-08
1622

1723
### Changed

pyproject.toml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
[project]
22
name = "mkdocs-note"
3-
version = "3.1.1"
3+
version = "3.1.2"
44
description = "A MkDocs plugin to add note boxes to your documentation."
55
readme = "README.md"
66
requires-python = ">=3.12"

src/mkdocs_note/utils/cli/commands.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -30,7 +30,7 @@ def _generate_note_basic_meta(self, file_path: Path, permalink: str) -> str:
3030
date: {datetime.now().strftime(self.timestamp_format)}
3131
title: {file_path.stem.replace("-", " ").replace("_", " ").title()}
3232
permalink: {permalink}
33-
publish: true
33+
publish: false
3434
tags:
3535
-
3636
---

uv.lock

Lines changed: 1 addition & 1 deletion
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

0 commit comments

Comments
 (0)