Skip to content

Commit

Permalink
feat: auto-generate html from markdown files for easier viewing and i…
Browse files Browse the repository at this point in the history
…mage embedding
  • Loading branch information
EddieDover committed Mar 6, 2024
1 parent f36fedc commit 994e15c
Show file tree
Hide file tree
Showing 4 changed files with 52 additions and 5 deletions.
14 changes: 11 additions & 3 deletions gulpfile.mjs
Expand Up @@ -7,6 +7,7 @@ import fs from "fs-extra";
import gulp from "gulp";
import { deleteAsync } from "del";
import sass from "gulp-dart-sass";
import markdown from "gulp-markdown";
import sourcemaps from "gulp-sourcemaps";
import path from "node:path";
import buffer from "vinyl-buffer";
Expand Down Expand Up @@ -79,8 +80,8 @@ async function copyFiles() {
* Cleans the dist folder
* @returns {NodeJS.ReadWriteStream} The cleaned files
*/
async function cleanDist() {
return await deleteAsync([`${distDirectory}/**/*`, `${distDirectory}`]);
function cleanDist() {
return deleteAsync([`${distDirectory}/**/*`, `${distDirectory}`]);
}

/**
Expand Down Expand Up @@ -116,7 +117,7 @@ export function watch() {
);
}

export const build = gulp.series(clean, buildCode, buildStyles, copyFiles); //gulp.parallel(buildCode, buildStyles, copyFiles));
export const build = gulp.series(clean, buildCode, buildStyles, copyFiles, convert_markdown); //gulp.parallel(buildCode, buildStyles, copyFiles));

/********************/
/* DEV EXPORT */
Expand Down Expand Up @@ -177,6 +178,13 @@ function getDataPaths() {
}
}

/**
* Convert markdown files to HTML
*/
export async function convert_markdown() {
await gulp.src("*.md").pipe(markdown()).pipe(gulp.dest("dist"));
}

/**
* Link build to User Data folder
*/
Expand Down
41 changes: 39 additions & 2 deletions package-lock.json

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

1 change: 1 addition & 0 deletions package.json
Expand Up @@ -52,6 +52,7 @@
"fs-extra": "^11.1.1",
"gulp": "^4.0.2",
"gulp-dart-sass": "^1.1.0",
"gulp-markdown": "^8.0.0",
"gulp-sourcemaps": "^3.0.0",
"gulp-zip": "^6.0.0",
"husky": "^8.0.3",
Expand Down
1 change: 1 addition & 0 deletions rollup.config.mjs
Expand Up @@ -16,6 +16,7 @@ export default () => ({
copy({
targets: [
{ src: "*.md", dest: "dist" },
// { src: "example_templates/*", dest: "dist/example_templates" },
{
src: "example_templates/**/*.json",
dest: "dist/example_templates",
Expand Down

0 comments on commit 994e15c

Please sign in to comment.