erudit 3.0.0-dev.2 → 3.0.0-dev.21

package/app/styles/normalize.scss

@@ -1,63 +1,49 @@
-// https://www.joshwcomeau.com/css/custom-css-reset/
-
-/* 1. Use a more-intuitive box-sizing model */
-*,
-*::before,
-*::after {
-    box-sizing: border-box;
-}
-
-/* 2. Remove default margin */
-* {
-    margin: 0;
-}
-
-body {
-    /* 3. Add accessible line-height */
-    line-height: 1.5;
-    /* 4. Improve text rendering */
-    -webkit-font-smoothing: antialiased;
-}
-
-/* 5. Improve media defaults */
-img,
-picture,
-video,
-canvas,
-svg {
-    display: block;
-    max-width: 100%;
-}
-
-/* 6. Inherit fonts for form controls */
-input,
-button,
-textarea,
-select {
-    font: inherit;
-}
-
-/* 7. Avoid text overflows */
-p,
-h1,
-h2,
-h3,
-h4,
-h5,
-h6 {
-    overflow-wrap: break-word;
-}
-
-/* 8. Improve line wrapping */
-p {
-    text-wrap: pretty;
-}
-
-h1,
-h2,
-h3,
-h4,
-h5,
-h6 {
-    text-wrap: balance;
-}
+// https://www.joshwcomeau.com/css/custom-css-reset/
+
+/* 1. Use a more-intuitive box-sizing model */
+*,
+*::before,
+*::after {
+    box-sizing: border-box;
+}
+
+/* 2. Remove default margin */
+* {
+    margin: 0;
+}
+
+body {
+    /* 3. Add accessible line-height */
+    line-height: 1.5;
+    /* 4. Improve text rendering */
+    -webkit-font-smoothing: antialiased;
+}
+
+/* 5. Improve media defaults */
+img,
+picture,
+video,
+canvas,
+svg {
+    display: block;
+    max-width: 100%;
+}
+
+/* 6. Inherit fonts for form controls */
+input,
+button,
+textarea,
+select {
+    font: inherit;
+}
+
+/* 7. Avoid text overflows */
+p,
+h1,
+h2,
+h3,
+h4,
+h5,
+h6 {
+    overflow-wrap: break-word;
+}

package/app/styles/partials/_darkMagic.scss

@@ -1,5 +1,5 @@
-@mixin replacer {
-    > div > div {
-        @content;
-    }
-}
+@mixin replacer {
+    > div > div {
+        @content;
+    }
+}

package/app/styles/partials/_fnav.scss

@@ -1,15 +1,15 @@
-.frontNavSeparator {
-    --_space: calc(var(--gap) / 2);
-}
-
-.frontNavItem + .frontNavSeparator {
-    border-top: 1px solid var(--border);
-    margin-top: var(--_space);
-    padding-top: var(--_space);
-}
-
-.frontNavSeparator:has(+ .frontNavItem:not(.frontNavSeparator)) {
-    border-bottom: 1px solid var(--border);
-    padding-bottom: var(--_space);
-    margin-bottom: var(--_space);
-}
+.frontNavSeparator {
+    --_space: calc(var(--gap) / 2);
+}
+
+.frontNavItem + .frontNavSeparator {
+    border-top: 1px solid var(--border);
+    margin-top: var(--_space);
+    padding-top: var(--_space);
+}
+
+.frontNavSeparator:has(+ .frontNavItem:not(.frontNavSeparator)) {
+    border-bottom: 1px solid var(--border);
+    padding-bottom: var(--_space);
+    margin-bottom: var(--_space);
+}

package/app/styles/partials/_preview.scss

@@ -1,5 +1,5 @@
-@mixin hasTheme {
-    [data-erudit-preview-theme] & {
-        @content;
-    }
-}
+@mixin hasTheme {
+    [data-erudit-preview-theme] & {
+        @content;
+    }
+}

package/bin/erudit.mjs

@@ -0,0 +1,2 @@
+#!/usr/bin/env node
+import '@erudit-js/cli/cli';

package/const.ts

@@ -0,0 +1,3 @@
+export const PUBLIC_ERUDIT_ASSET = '/erudit-asset/';
+export const PUBLIC_CONTENT_ASSET = '/user-asset/content/';
+export const PUBLIC_USER_ASSET = '/user-asset/public/';

package/globalPath.ts

@@ -1,21 +1,21 @@
-import { fileURLToPath } from 'node:url';
-import { resolvePaths } from 'erudit-cog/kit';
-
-export const ERUDIT_DIR = resolvePaths(fileURLToPath(import.meta.url), '..');
-export const PROJECT_DIR = process.env.ERUDIT_PROJECT_DIR as string;
-
-export function eruditPath(path?: string) {
-    return path ? `${ERUDIT_DIR}/${path}` : ERUDIT_DIR;
-}
-
-export function projectPath(path?: string) {
-    return path ? `${PROJECT_DIR}/${path}` : PROJECT_DIR;
-}
-
-export function eruditBuildPath(path?: string) {
-    return projectPath('.erudit' + (path ? '/' + path : ''));
-}
-
-export function eruditEndNuxtPath(path?: string) {
-    return eruditBuildPath('nuxt' + (path ? '/' + path : ''));
-}
+import { fileURLToPath } from 'node:url';
+import { resolvePaths } from '@erudit-js/cog/kit';
+
+export const ERUDIT_DIR = resolvePaths(fileURLToPath(import.meta.url), '..');
+export const PROJECT_DIR = process.env.ERUDIT_PROJECT_DIR as string;
+
+export function eruditPath(path?: string) {
+    return path ? `${ERUDIT_DIR}/${path}` : ERUDIT_DIR;
+}
+
+export function projectPath(path?: string) {
+    return path ? `${PROJECT_DIR}/${path}` : PROJECT_DIR;
+}
+
+export function eruditBuildPath(path?: string) {
+    return projectPath('.erudit' + (path ? '/' + path : ''));
+}
+
+export function eruditEndNuxtPath(path?: string) {
+    return eruditBuildPath('nuxt' + (path ? '/' + path : ''));
+}

package/globals/bitran.ts

@@ -1,47 +1 @@
-import type { GenericElementSchema } from '@bitran-js/core';
-import type { ElementTranspiler } from '@bitran-js/transpiler';
-import type { ElementVueRenderer } from '@bitran-js/renderer-vue';
-
-export interface BitranElementConfig<
-    T extends GenericElementSchema = GenericElementSchema,
-> {
-    transpiler: () => Promise<ElementTranspiler<T>>;
-    renderer: () => Promise<ElementVueRenderer<T>>;
-}
-
-export type BitranElements = Record<string, BitranElementConfig>;
-
-export interface EruditBitranConfig<
-    TElements extends BitranElements = BitranElements,
-> {
-    elements: TElements;
-    toc: (keyof TElements)[];
-
-    /**
-     * TODO!
-     * Groups of elements that are tracked on site, included in TOC, in search, display in front and book pages and so on.
-     *
-     * Example:
-     * tracked: {
-     *     term: {
-     *        elements: ['definition', 'axiom'],
-              title: 'Термин',
-              toc: true,
-              search: false,
-              color: '#E0E0E0',
-     *     }
-     * }
-     */
-}
-
-export function defineBitranConfig<T extends BitranElements>(
-    config: Partial<EruditBitranConfig<T>>,
-) {
-    return config;
-}
-
-export function defineBitranElement<T extends GenericElementSchema>(
-    config: BitranElementConfig<T>,
-) {
-    return config;
-}
+export { defineServerBitran, defineAppBitran } from '@erudit-js/cog/schema';

package/globals/cameo.ts

@@ -0,0 +1,5 @@
+import type { CameoConfig } from '@erudit-js/cog/schema';
+
+export function defineCameo(cameoConfig: CameoConfig) {
+    return cameoConfig;
+}

package/globals/content.ts

@@ -1,22 +1,27 @@
-import type {
-    BookConfig,
-    ContentReferences,
-    GroupConfig,
-    TopicConfig,
-} from 'erudit-cog/schema';
-
-export function defineBook(book: Partial<BookConfig>) {
-    return book;
-}
-
-export function defineGroup(group: Partial<GroupConfig>) {
-    return group;
-}
-
-export function defineTopic(topic: Partial<TopicConfig>) {
-    return topic;
-}
-
-export function defineContentReferences(references: ContentReferences) {
-    return references;
-}
+import type {
+    BookConfig,
+    ContentReferences,
+    ContentReferenceSource,
+    GroupConfig,
+    TopicConfig,
+} from '@erudit-js/cog/schema';
+
+export function defineBook(book: Partial<BookConfig>) {
+    return book;
+}
+
+export function defineGroup(group: Partial<GroupConfig>) {
+    return group;
+}
+
+export function defineTopic(topic: Partial<TopicConfig>) {
+    return topic;
+}
+
+export function defineContentReferences(references: ContentReferences) {
+    return references;
+}
+
+export function defineContentSource(source: ContentReferenceSource) {
+    return source;
+}

package/globals/contributor.ts

@@ -1,5 +1,5 @@
-import type { ContributorConfig } from 'erudit-cog/schema';
-
-export function defineContributor(contributor: Partial<ContributorConfig>) {
-    return contributor;
-}
+import type { ContributorConfig } from '@erudit-js/cog/schema';
+
+export function defineContributor(contributor: Partial<ContributorConfig>) {
+    return contributor;
+}

package/globals/erudit.ts

@@ -1,5 +1,5 @@
-import type { EruditConfig } from 'erudit-cog/schema';
-
-export function defineEruditConfig(eruditConfig: Partial<EruditConfig>) {
-    return eruditConfig;
-}
+import type { EruditConfig } from '@erudit-js/cog/schema';
+
+export function defineEruditConfig(eruditConfig: Partial<EruditConfig>) {
+    return eruditConfig;
+}

package/globals/register.ts

@@ -1,18 +1,23 @@
-import * as erudit from './erudit';
-import * as contributor from './contributor';
-import * as bitran from './bitran';
-import * as content from './content';
-import * as asset from '@shared/asset';
-
-export function registerGlobals() {
-    for (const [key, value] of Object.entries({
-        ...erudit,
-        ...contributor,
-        ...bitran,
-        ...content,
-        ...asset,
-    })) {
-        // @ts-ignore
-        globalThis[key] = value;
-    }
-}
+import * as erudit from './erudit';
+import * as contributor from './contributor';
+import * as bitran from './bitran';
+import * as content from './content';
+import * as cameo from './cameo';
+import * as sponsor from './sponsor';
+
+import * as asset from '@shared/asset';
+
+export function registerGlobals() {
+    for (const [key, value] of Object.entries({
+        ...erudit,
+        ...contributor,
+        ...bitran,
+        ...content,
+        ...asset,
+        ...cameo,
+        ...sponsor,
+    })) {
+        // @ts-ignore
+        globalThis[key] = value;
+    }
+}

package/globals/sponsor.ts

@@ -0,0 +1,17 @@
+import type {
+    SponsorConfig,
+    Tier1Sponsor,
+    Tier2Sponsor,
+} from '@erudit-js/cog/schema';
+
+export function defineTier1Sponsor(
+    sponsorConfig: SponsorConfig<Tier1Sponsor>,
+): SponsorConfig<Tier1Sponsor> {
+    return sponsorConfig;
+}
+
+export function defineTier2Sponsor(
+    sponsorConfig: SponsorConfig<Tier2Sponsor>,
+): SponsorConfig<Tier2Sponsor> {
+    return sponsorConfig;
+}

package/languages/en.ts

@@ -1,95 +1,108 @@
-const english: EruditPhrases = {
-    _language_title: 'English',
-    _language_code: 'en',
-
-    site_info_title: 'Erudit',
-    site_info_slogan: 'Modern textbook',
-    seo_index_title: 'Erudit - CMS for eductional sites',
-    seo_index_description:
-        'Erudit is a CMS for creating and managing perfect educational sites, maintained by the community.',
-    seo_article_description: (contentTitle) =>
-        `Clear and interesting explanation of the topic "${contentTitle}". Illustrative examples, important properties, interesting facts, life applications, clear proofs. Here you will definitely understand the topic!`,
-    seo_summary_description: (contentTitle) =>
-        `Summary of the topic "${contentTitle}": key definitions, theorems, properties and examples of their use. All the most important things in a concise form!`,
-    seo_practice_description: (contentTitle) =>
-        `Various problems with hints and answers on the topic "${contentTitle}". Interesting conditions, hints and detailed solutions. Turn knowledge into a skill!`,
-    index: 'Index',
-    pages: 'Pages',
-    search: 'Search',
-    language: 'Language',
-    other: 'Other',
-    ads_replacer:
-        'Help us develop the project.<br><strong>Disable your ads blocker!</strong>',
-    theme: 'Theme',
-    theme_system: 'System',
-    theme_light: 'Light',
-    theme_dark: 'Dark',
-    content: 'Content',
-    generator: 'Generator',
-    main_page: 'Main page',
-    members: 'Members',
-    add_translation: 'Add translation',
-    empty_nav: 'Empty navigation',
-    flag_dev: 'Development',
-    flag_dev_description:
-        'This material is in development! It may change in the future and even contain errors!',
-    flag_advanced: 'Advanced',
-    flag_advanced_description:
-        'This material is for learners with a high level of knowledge. It contains information that is not suitable for beginners!',
-    flag_secondary: 'Additional',
-    flag_secondary_description:
-        'This is an optional material is for learners who want to dive deeper and gain additional knowledge and context.',
-    popover_dependencies: 'Dependencies',
-    popover_dependencies_description:
-        'There is no royal way into this topic! You can only figure it out if you know the following topics:',
-    to_index: 'To index',
-    about_book: 'About book',
-    close: 'Close',
-    back: 'Back',
-    goto: 'Go to',
-    error: 'Error!',
-    external_link: 'External link',
-    external_link_warn: 'You are going to visit external resource!',
-    internal_link: 'Internal link',
-    internal_link_warn: 'You are going to visit internal site page!',
-    book: 'Book',
-    group: 'Group',
-    topic: 'Topic',
-    article: 'Article',
-    summary: 'Summary',
-    practice: 'Practice',
-    contributor: 'Contributor',
-    element_id: 'Element ID',
-    preview_missing_title: 'Element not found!',
-    preview_missing_explain: `Can't find the element with specified ID in this page!<br>Perhaps the element ID is specified incorrectly or the element has been changed/deleted.`,
-    preview_missing_explain_mismatch: `Can't find the element with specified ID in this page!<br>The version of the linked page is different from the current version of the page!<br>This is most likely the cause of the error.`,
-    preview_hash_mismatch_title: 'Page version mismatch!',
-    preview_hash_mismatch_explain:
-        'The version of the page you see now is different from the version of the page the original link led to!<br>The content may be different from what you expected to see.',
-    current_page_hash: 'Current hash',
-    expected_page_hash: 'Expected hash',
-    empty_toc: 'Empty table of contents...',
-    contributors: 'Contributors',
-    no_contributors: 'No contributors...',
-    make_contribution: 'Make a contribution',
-    material_improvement: 'Material improvement',
-    how_to_improve: 'How to improve?',
-    edit_page: 'Edit page',
-    report_problem: 'Report a problem',
-    references: 'References',
-    reference_source_featured: 'Featured source',
-    references_description:
-        'List of external sources that were used in writing this material. For a deeper dive into the material, it is recommended to read them in more detail, especially the featured sources, which are marked with an asterisk:',
-};
-
-export default english;
-
-export function m(
-    number: number,
-    one: string,
-    few: string,
-    includeNumber = true,
-) {
-    const text = number === 1 ? one : few;
-    return includeNumber ? `${number} ${text}` : text;
-}
+const english: EruditPhrases = {
+    _language_title: 'English',
+    _language_code: 'en',
+
+    site_info_title: 'Erudit',
+    site_info_slogan: 'Modern textbook',
+    seo_index_title: 'Erudit - CMS for eductional sites',
+    seo_index_description:
+        'Erudit is a CMS for creating and managing perfect educational sites, maintained by the community.',
+    seo_article_description: (contentTitle) =>
+        `Clear and interesting explanation of the topic "${contentTitle}". Illustrative examples, important properties, interesting facts, life applications, clear proofs. Here you will definitely understand the topic!`,
+    seo_summary_description: (contentTitle) =>
+        `Summary of the topic "${contentTitle}": key definitions, theorems, properties and examples of their use. All the most important things in a concise form!`,
+    seo_practice_description: (contentTitle) =>
+        `Various problems with hints and answers on the topic "${contentTitle}". Interesting conditions, hints and detailed solutions. Turn knowledge into a skill!`,
+    index: 'Index',
+    pages: 'Pages',
+    search: 'Search',
+    language: 'Language',
+    other: 'Other',
+    ads_replacer:
+        'Help us develop the project.<br><strong>Disable your ads blocker!</strong>',
+    theme: 'Theme',
+    theme_system: 'System',
+    theme_light: 'Light',
+    theme_dark: 'Dark',
+    content: 'Content',
+    main_page: 'Main page',
+    contributors: 'Contributors',
+    contributors_page_description:
+        'List of people who contributed to the project materials: suggested valuable ideas, made corrections to existing material or wrote their own!',
+    contributors_page_invite:
+        'You can also help the project, make a contribution and get on this page!',
+    become_contributor: 'Become a contributor',
+    contributor: 'Contributor',
+    contribution: 'Contribution',
+    contributions_explain: (count) =>
+        `Contributed to ${m(count, 'material', 'materials')}`,
+    contributor_description: (name) =>
+        `Page with information about the contributor "${name}" and his contribution to the project.`,
+    editor: 'Editor',
+    add_translation: 'Add translation',
+    empty_nav: 'Empty navigation',
+    flag_dev: 'Development',
+    flag_dev_description:
+        'This material is in development! It may change in the future and even contain errors!',
+    flag_advanced: 'Advanced',
+    flag_advanced_description:
+        'This material is for learners with a high level of knowledge. It contains information that is not suitable for beginners!',
+    flag_secondary: 'Additional',
+    flag_secondary_description:
+        'This is an optional material is for learners who want to dive deeper and gain additional knowledge and context.',
+    popover_dependencies: 'Dependencies',
+    popover_dependencies_description:
+        'There is no royal way into this topic! You can only figure it out if you know the following topics:',
+    to_index: 'To index',
+    about_book: 'About book',
+    close: 'Close',
+    back: 'Back',
+    goto: 'Go to',
+    error: 'Error!',
+    external_link: 'External link',
+    external_link_warn: 'You are going to visit external resource!',
+    internal_link: 'Internal link',
+    internal_link_warn: 'You are going to visit internal site page!',
+    book: 'Book',
+    group: 'Group',
+    topic: 'Topic',
+    article: 'Article',
+    summary: 'Summary',
+    practice: 'Practice',
+    element_id: 'Element ID',
+    preview_missing_title: 'Element not found!',
+    preview_missing_explain: `Can't find the element with specified ID in this page!<br>Perhaps the element ID is specified incorrectly or the element has been changed/deleted.`,
+    preview_missing_explain_mismatch: `Can't find the element with specified ID in this page!<br>The version of the linked page is different from the current version of the page!<br>This is most likely the cause of the error.`,
+    preview_hash_mismatch_title: 'Page version mismatch!',
+    preview_hash_mismatch_explain:
+        'The version of the page you see now is different from the version of the page the original link led to!<br>The content may be different from what you expected to see.',
+    current_page_hash: 'Current hash',
+    expected_page_hash: 'Expected hash',
+    empty_toc: 'Empty table of contents...',
+    no_contributors: 'No contributors...',
+    make_contribution: 'Make a contribution',
+    material_improvement: 'Material improvement',
+    how_to_improve: 'How to improve?',
+    edit_page: 'Edit page',
+    report_problem: 'Report a problem',
+    references: 'References',
+    reference_source_featured: 'Featured source',
+    references_description:
+        'A list of external sources that were used to write this material. If there is an asterisk next to the title, it is a featured source and is worth reading if you want to delve deeper into the material.',
+    sponsors: 'Sponsors',
+    sponsors_description:
+        'People and organizations that support the project financially. Thanks to them, we can continue to develop the project and improve the quality of materials. If you want to support the project, you can become a sponsor too!',
+    become_sponsor: 'Become a sponsor',
+};
+
+export default english;
+
+export function m(
+    number: number,
+    one: string,
+    few: string,
+    includeNumber = true,
+) {
+    const text = number === 1 ? one : few;
+    return includeNumber ? `${number} ${text}` : text;
+}