Skip to content

Commit d9fba91

Browse files
committed
chore: update documentation and ignore files
- Added new package entries for mdx and docs in CONTRIBUTING.md and contributing.mdx for better clarity on project structure. - Updated .gitignore to exclude TypeScript build info files (*.tsbuildinfo) to streamline the development process. - Enhanced overall documentation for improved guidance on contributing to the project.
1 parent a88c8c0 commit d9fba91

4 files changed

Lines changed: 18 additions & 1 deletion

File tree

.gitignore

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -17,6 +17,7 @@ Thumbs.db
1717
# Logs
1818
*.log
1919
npm-debug.log*
20+
*.tsbuildinfo
2021

2122
# Test coverage
2223
coverage/

CONTRIBUTING.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -14,8 +14,10 @@ This project is a monorepo managed with [Turborepo](https://turbo.build/) and [p
1414
create-markdown/
1515
├── packages/
1616
│ ├── core/ # @create-markdown/core - Zero-dep parsing/serialization
17+
│ ├── mdx/ # @create-markdown/mdx - Markdown to MDX conversion
1718
│ ├── react/ # @create-markdown/react - React components and hooks
1819
│ ├── preview/ # @create-markdown/preview - HTML rendering with plugins
20+
│ ├── docs/ # @create-markdown/docs - Documentation site
1921
│ └── create-markdown/ # Convenience bundle re-exporting all packages
2022
├── playground/ # Demo application
2123
└── .changeset/ # Changesets for version management

packages/docs/content/contributing.mdx

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -19,8 +19,10 @@ This project is a monorepo managed with [Turborepo](https://turbo.build/) and [p
1919
create-markdown/
2020
├── packages/
2121
│ ├── core/ # @create-markdown/core - Zero-dep parsing/serialization
22+
│ ├── mdx/ # @create-markdown/mdx - Markdown to MDX conversion
2223
│ ├── react/ # @create-markdown/react - React components and hooks
2324
│ ├── preview/ # @create-markdown/preview - HTML rendering with plugins
25+
│ ├── docs/ # @create-markdown/docs - Documentation site
2426
│ └── create-markdown/ # Convenience bundle re-exporting all packages
2527
├── playground/ # Demo application
2628
└── .changeset/ # Changesets for version management

scripts/release.sh

Lines changed: 13 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -65,7 +65,19 @@ sync_version_constants() {
6565
for src_file in "$pkg_dir"src/index.ts "$pkg_dir"src/index.js; do
6666
[[ -f "$src_file" ]] || continue
6767
if grep -q "VERSION\s*=" "$src_file"; then
68-
sed -i '' "s/VERSION\s*=\s*['\"][^'\"]*['\"]/VERSION = '${pkg_ver}'/" "$src_file"
68+
python3 - "$src_file" "$pkg_ver" <<'PY'
69+
from pathlib import Path
70+
import re
71+
import sys
72+
73+
path = Path(sys.argv[1])
74+
version = sys.argv[2]
75+
source = path.read_text()
76+
updated = re.sub(r"VERSION\s*=\s*['\"][^'\"]*['\"]", f"VERSION = '{version}'", source)
77+
78+
if updated != source:
79+
path.write_text(updated)
80+
PY
6981
info "Synced VERSION in $src_file$pkg_ver"
7082
fi
7183
done

0 commit comments

Comments
 (0)