Skip to content

Commit e73c57d

Browse files
committed
Set up parceljs
1 parent 9f3dc7d commit e73c57d

File tree

19 files changed

+3288
-9
lines changed

19 files changed

+3288
-9
lines changed

.github/actions/bootstrap/action.yml

Lines changed: 8 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -30,4 +30,11 @@ runs:
3030
echo "Version Number: ${REPO_VERSION}"
3131
echo "REPO_VERSION=${REPO_VERSION}" >> $GITHUB_ENV
3232
echo "full-version=${REPO_VERSION}" >> $GITHUB_OUTPUT
33-
echo "major-version=$(echo ${REPO_VERSION} | cut -d"." -f1)" >> $GITHUB_OUTPUT
33+
echo "major-version=$(echo ${REPO_VERSION} | cut -d"." -f1)" >> $GITHUB_OUTPUT
34+
35+
- uses: actions/setup-node@v4
36+
with:
37+
cache: npm
38+
cache-dependency-path: src/Elastic.Markdown/package-lock.json
39+
node-version-file: .nvmrc
40+

.nvmrc

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
22.13.1

README.md

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -137,6 +137,25 @@ To test performance it's best to build the binary and run outside of docker:
137137
For reference here's the `markitpy-doc` docset (50k markdown files) currently takes `14s` vs `several minutes` compared to
138138
existing surveyed tools
139139

140+
# Local Development
141+
142+
## Preqrequisites
143+
144+
- [.NET 9.0 SDK](https://dotnet.microsoft.com/en-us/download/dotnet/9.0)
145+
- [Node.js 22.13.1 (LTS)](https://nodejs.org/en/blog/release/v22.13.1)
146+
147+
## Live Reload Markdown files in the `docs` folder:
148+
```shell
149+
dotnet run --project src/docs-builder -- serve
150+
```
151+
152+
## Automatically rebuild changes to `src/Elastic.Markdown/Assets` JS and CSS files:
153+
```shell
154+
cd src/Elastic.Markdown
155+
npm ci
156+
npm run watch
157+
```
158+
140159
# Release Process
141160

142161
This section outlines the process for releasing a new version of this project.

src/Elastic.Markdown/.gitignore

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
.parcel-cache/
2+
node_modules/
3+
_static/main.js
4+
_static/main.js.map
5+
_static/styles.css
6+
_static/styles.css.map

0 commit comments

Comments
 (0)