Skip to content

Commit

Permalink
refactor: simplify package structure + support archives
Browse files Browse the repository at this point in the history
  • Loading branch information
edeleastar committed Aug 3, 2023
1 parent f08449b commit 1d04c2b
Show file tree
Hide file tree
Showing 34 changed files with 121 additions and 106 deletions.
File renamed without changes.

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

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

Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
import { LearningObject } from "tutors-gen-lib/src/lo/lo-types";
import { convertMdToHtml } from "../utils/markdown-utils";
import { convertMdToHtml } from "./markdown";

export function buildCourseTree(parent: LearningObject) {
for (const lo of parent.los) {
Expand Down
File renamed without changes.
File renamed without changes.
File renamed without changes.

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

1 change: 1 addition & 0 deletions cli/tutors-gen-html/src/lo/markdown.js.map

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

47 changes: 47 additions & 0 deletions cli/tutors-gen-html/src/lo/markdown.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,47 @@
import hljs from "highlight.js";
import MarkdownIt from "markdown-it";
import latex from "@iktakahiro/markdown-it-katex";
import anchor from "markdown-it-anchor";
import toc from "markdown-it-table-of-contents";
import emoji from "markdown-it-emoji";
import sub from "markdown-it-sub";
import sup from "markdown-it-sup";
import mark from "markdown-it-mark";
import footnote from "markdown-it-footnote";
import deflist from "markdown-it-deflist";

const markdownIt: any = new MarkdownIt({
html: false, // Enable HTML tags in source
xhtmlOut: false, // Use '/' to close single tags (<br />).
breaks: false, // Convert '\n' in paragraphs into <br>
langPrefix: "language-", // CSS language prefix for fenced blocks. Can be
linkify: false, // Autoconvert URL-like text to links
typographer: true,
quotes: "“”‘’",
highlight: function (str, lang) {
if (lang && hljs.getLanguage(lang)) {
try {
return '<pre class="hljs"><code>' + hljs.highlight(str, { language: lang, ignoreIllegals: true }).value + "</code></pre>";
} catch (__) {}
}
return '<pre class="hljs"><code>' + markdownIt.utils.escapeHtml(str) + "</code></pre>";
},
});

const tocOptions = { includeLevel: [1, 2, 3] };
markdownIt.use(latex);
markdownIt.use(anchor, {
permalink: anchor.permalink.headerLink(),
});

markdownIt.use(toc, tocOptions);
markdownIt.use(emoji);
markdownIt.use(sub);
markdownIt.use(sup);
markdownIt.use(mark);
markdownIt.use(footnote);
markdownIt.use(deflist);

export function convertMdToHtml(md: string): string {
return markdownIt.render(md);
}
File renamed without changes.
File renamed without changes.
2 changes: 1 addition & 1 deletion cli/tutors-gen-html/src/tutors-html.js

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

2 changes: 1 addition & 1 deletion cli/tutors-gen-html/src/tutors-html.js.map

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

4 changes: 2 additions & 2 deletions cli/tutors-gen-html/src/tutors-html.ts
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ import { resourceBuilder } from "tutors-gen-lib/src/lo/resource-builder";
import { courseBuilder } from "tutors-gen-lib/src/lo/course-builder";
import { writeFile } from "tutors-gen-lib/src/utils/utils";
import * as nunjucks from "nunjucks";
import { courseBuilderHtml } from "./controllers/html-emitter";
import { courseBuilderHtml } from "./lo/html-emitter";

const version = `tutors-html: 2.6.2 (tutors-lib: 2.6.2)`;

Expand All @@ -20,7 +20,7 @@ if (fs.existsSync("course.md")) {
courseBuilder.buildCourse(resourceBuilder.lr);
resourceBuilder.copyAssets(destFolder);
writeFile(destFolder, "tutors.json", JSON.stringify(courseBuilder.lo));
courseBuilderHtml.generateCourse(destFolder, courseBuilder.lo)
courseBuilderHtml.generateCourse(destFolder, courseBuilder.lo);
console.log(`${version}`);
} else {
console.log("Cannot locate course.md. Change to course folder and try again. ");
Expand Down
3 changes: 0 additions & 3 deletions cli/tutors-gen-html/src/utils/markdown-parser.d.ts

This file was deleted.

1 change: 0 additions & 1 deletion cli/tutors-gen-html/src/utils/markdown-parser.js.map

This file was deleted.

1 change: 0 additions & 1 deletion cli/tutors-gen-html/src/utils/markdown-toc-lib.d.ts

This file was deleted.

1 change: 0 additions & 1 deletion cli/tutors-gen-html/src/utils/markdown-toc-lib.js.map

This file was deleted.

1 change: 0 additions & 1 deletion cli/tutors-gen-html/src/utils/markdown-utils.js.map

This file was deleted.

51 changes: 0 additions & 51 deletions cli/tutors-gen-html/src/utils/markdown-utils.ts

This file was deleted.

2 changes: 2 additions & 0 deletions cli/tutors-gen-html/src/views/components/cards/url.njk
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,8 @@
{% set url = lo.route + ' target="_blank"' %}
{% elif (lo.type == "talk") %}
{% set url = path + '/' + lo.id + '/' + lo.pdfFile + ' target="_blank"' %}
{% elif (lo.type == "archive") %}
{% set url = path + '/' +lo.id + "/" + lo.archiveFile %}
{% else %}
{% set url = path + '/' +lo.id + "/index.html" %}
{% endif %}
Expand Down
2 changes: 2 additions & 0 deletions cli/tutors-gen-html/src/views/layouts/main.html
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,8 @@

<link rel="stylesheet" href="https://cdn.jsdelivr.net/npm/@vime/core@^4/themes/default.css" />
<link rel="stylesheet" href="https://cdn.jsdelivr.net/npm/@vime/core@^4/themes/light.css" />
<link rel="stylesheet" href="https://cdn.jsdelivr.net/npm/katex@0.16.8/dist/katex.min.css" integrity="sha384-GvrOXuhMATgEsSwCs4smul74iXGOixntILdUW9XmUC6+HX0sLNAK3q71HotJqlAn" crossorigin="anonymous"/>

<script type="module" src="https://cdn.jsdelivr.net/npm/@vime/core@^4/dist/vime/vime.esm.js"></script>
</head>

Expand Down
Loading

0 comments on commit 1d04c2b

Please sign in to comment.