docula 0.31.2 → 0.41.0

package/template/css/base.css

@@ -193,6 +193,140 @@ hr {
   text-decoration: underline;
 }
 
+/* Changelog */
+.changelog-entry {
+  overflow: hidden;
+  width: 100%;
+  line-break: anywhere;
+  margin-top: 2rem;
+  padding-bottom: 2rem;
+  border-bottom: 1px solid var(--border);
+  color: var(--color-text);
+}
+
+.changelog-entry:last-child {
+  border-bottom: none;
+}
+
+.changelog-entry-header {
+  display: flex;
+  align-items: center;
+  gap: 0.75rem;
+  margin-bottom: 0.5rem;
+  flex-wrap: wrap;
+}
+
+.changelog-entry-title {
+  font-size: 1.375rem;
+  color: var(--color-primary);
+  font-weight: 700;
+  transition: color .3s;
+}
+
+a.changelog-entry-title:hover {
+  color: var(--color-secondary-dark);
+}
+
+h1.changelog-entry-title {
+  font-size: 1.875rem;
+  margin: 0;
+}
+
+.changelog-entry-date {
+  font-size: 0.75rem;
+  display: block;
+  margin-bottom: 1rem;
+}
+
+.changelog-tag {
+  display: inline-block;
+  padding: 0.2rem 0.6rem;
+  border-radius: 1rem;
+  font-size: 0.7rem;
+  font-weight: 600;
+  text-transform: uppercase;
+  letter-spacing: 0.025em;
+}
+
+.changelog-tag-added {
+  background-color: rgba(140, 220, 0, 0.15);
+  color: #4a7a00;
+}
+
+.changelog-tag-improved {
+  background-color: rgba(59, 130, 246, 0.15);
+  color: #1d4ed8;
+}
+
+.changelog-tag-fixed {
+  background-color: rgba(245, 158, 11, 0.15);
+  color: #b45309;
+}
+
+.changelog-tag-removed {
+  background-color: rgba(239, 68, 68, 0.15);
+  color: #b91c1c;
+}
+
+.changelog-tag-deprecated {
+  background-color: rgba(156, 163, 175, 0.15);
+  color: #4b5563;
+}
+
+.changelog-tag-security {
+  background-color: rgba(168, 85, 247, 0.15);
+  color: #6d28d9;
+}
+
+.changelog-entry-body p {
+  margin: 0.5rem 0;
+}
+
+.changelog-entry-body pre {
+  margin-bottom: 2rem;
+}
+
+.changelog-entry-body h1 {
+  font-size: 1.375rem;
+  margin-bottom: 1rem;
+}
+
+.changelog-entry-body h2 {
+  font-size: 1.125rem;
+  margin-top: 1.75rem;
+  margin-bottom: 1rem;
+}
+
+.changelog-entry-body ul {
+  padding-left: 1rem;
+}
+
+.changelog-entry-body ul > li {
+  margin-bottom: 0.75rem;
+}
+
+.changelog-entry-body ul > li a {
+  text-decoration: underline;
+}
+
+.changelog-entry-nav {
+  margin-bottom: 1.5rem;
+}
+
+.changelog-entry-nav a {
+  color: var(--color-primary);
+  font-size: 0.875rem;
+  transition: color .3s;
+}
+
+.changelog-entry-nav a:hover {
+  color: var(--color-secondary-dark);
+}
+
+.changelog-entry-single {
+  border-bottom: none;
+}
+
 .github-corner {
   fill: var(--color-primary) !important;
 }
@@ -378,6 +512,9 @@ footer img {
   .release {
     margin-bottom: 4rem;
   }
+  .changelog-entry {
+    margin-bottom: 2rem;
+  }
   .versions-container {
     margin-bottom: 4.5rem;
   }
@@ -417,6 +554,9 @@ footer img {
   .content h1 {
     font-size: 1.9rem;
   }
+  h1.changelog-entry-title {
+    font-size: 2.25rem;
+  }
   .content > ul, .content > ol {
     padding-left: 2rem;
   }

package/template/css/multipage.css

@@ -25,6 +25,48 @@
   font-weight: 600;
 }
 
+/* Announcement */
+.announcement {
+  max-width: 90%;
+  margin: 0 auto 2rem;
+  padding: 1rem 1.5rem;
+  background-color: var(--sidebar-background);
+  border: 1px solid var(--border);
+  border-left: 4px solid var(--color-secondary);
+  border-radius: 0.5rem;
+  text-align: left;
+}
+
+.announcement p {
+  margin: 0;
+  line-height: 1.6;
+}
+
+.announcement p + p {
+  margin-top: 0.5rem;
+}
+
+.announcement a {
+  color: var(--color-primary);
+  text-decoration: underline;
+  font-weight: 500;
+}
+
+.announcement a:hover {
+  color: var(--color-secondary-dark);
+}
+
+.announcement strong {
+  color: var(--color-secondary-dark);
+}
+
+.announcement code {
+  background-color: var(--code);
+  padding: 0.125rem 0.375rem;
+  border-radius: 0.25rem;
+  font-size: 0.875em;
+}
+
 /* Docs */
 .nav {
   padding-left: 1rem;
@@ -199,10 +241,6 @@ details > summary {
   margin-right: 2rem
 }
 
-.main-toc {
-  padding-bottom: 1.5rem;
-}
-
 .toc {
   font-size: 0.875rem;
 }
@@ -245,18 +283,6 @@ details > summary {
   text-decoration: none;
 }
 
-.main-toc ul > li > a::after {
-  position: absolute;
-  right: 0;
-  content: '';
-  display: inline-block;
-  width: 0.25rem;
-  height: 0.25rem;
-  border-right: 1px solid var(--color-primary);
-  border-bottom: 1px solid var(--color-primary);
-  transform: rotate(-45deg);
-}
-
 .fixed-toc {
   display: none;
   position: fixed;

package/template/includes/multipage/doc.hbs

@@ -2,16 +2,22 @@
   <div class="main-content">
     <article class="content">
       <h1>{{title}}</h1>
-      <div class="toc main-toc">
-{{tableOfContents}}
-      </div>
 {{generatedHtml}}
     </article>
     <div class="fixed-toc-container">
       <div class="toc fixed-toc" id="fixed-toc">
-        {{tableOfContents}}
       </div>
     </div>
     </div>
 
-</div>
+</div>
+<script>
+  const tocHeading = document.getElementById('table-of-contents');
+  if (tocHeading) {
+    const tocList = tocHeading.nextElementSibling;
+    const fixedToc = document.getElementById('fixed-toc');
+    if (tocList && tocList.tagName === 'UL' && fixedToc) {
+      fixedToc.innerHTML = tocList.outerHTML;
+    }
+  }
+</script>

package/template/includes/multipage/hero.hbs

@@ -3,5 +3,10 @@
   <div class="hero-container">
     <h1>{{ siteDescription }}</h1>
   </div>
+  {{#if announcement}}
+  <div class="announcement">
+    {{{announcement}}}
+  </div>
+  {{/if}}
   <a href="/docs" class="home-docs-button">Documentation</a>
 </section>

package/template/includes/singlepage/hero.hbs

@@ -1,3 +1,8 @@
 <header class="home-hero">
   <img src="/logo.svg" alt="logo" />
+  {{#if announcement}}
+  <div class="announcement">
+    {{{announcement}}}
+  </div>
+  {{/if}}
 </header>

package/dist/docula.d.ts

@@ -1,130 +0,0 @@
-import http from 'node:http';
-export { Writr } from 'writr';
-
-type DoculaSection = {
-    name: string;
-    order?: number;
-    path: string;
-    children?: DoculaSection[];
-};
-
-declare class DoculaOptions {
-    /**
-     * Path to the template directory
-     */
-    templatePath: string;
-    /**
-     * Path to the output directory
-     */
-    outputPath: string;
-    /**
-     * Path to the site directory
-     */
-    sitePath: string;
-    /**
-     * Path to the github repository
-     */
-    githubPath: string;
-    /**
-     * Site title
-     */
-    siteTitle: string;
-    /**
-     * Site description
-     */
-    siteDescription: string;
-    /**
-     * Site URL
-     */
-    siteUrl: string;
-    /**
-     * Port to run the server
-     */
-    port: number;
-    /**
-     * Single page website
-     */
-    singlePage: boolean;
-    /**
-     * Sections
-     */
-    sections?: DoculaSection[];
-    constructor(options?: Record<string, unknown>);
-    parseOptions(options: Record<string, any>): void;
-}
-
-declare class Docula {
-    private _options;
-    private readonly _console;
-    private _configFileModule;
-    private _server;
-    /**
-     * Initialize the Docula class
-     * @param {DoculaOptions} options
-     * @returns {void}
-     * @constructor
-     */
-    constructor(options?: DoculaOptions);
-    /**
-     * Get the options
-     * @returns {DoculaOptions}
-     */
-    get options(): DoculaOptions;
-    /**
-     * Set the options
-     * @param {DoculaOptions} value
-     */
-    set options(value: DoculaOptions);
-    /**
-     * The http server used to serve the site
-     * @returns {http.Server | undefined}
-     */
-    get server(): http.Server | undefined;
-    /**
-     * The config file module. This is the module that is loaded from the docula.config.mjs file
-     * @returns {any}
-     */
-    get configFileModule(): any;
-    /**
-     * Check for updates
-     * @returns {void}
-     */
-    checkForUpdates(): void;
-    /**
-     * Is the execution process that runs the docula command
-     * @param {NodeJS.Process} process
-     * @returns {Promise<void>}
-     */
-    execute(process: NodeJS.Process): Promise<void>;
-    /**
-     * Checks if the site is a single page website
-     * @param {string} sitePath
-     * @returns {boolean}
-     */
-    isSinglePageWebsite(sitePath: string): boolean;
-    /**
-     * Generate the init files
-     * @param {string} sitePath
-     * @returns {void}
-     */
-    generateInit(sitePath: string): void;
-    /**
-     * Get the version of the package
-     * @returns {string}
-     */
-    getVersion(): string;
-    /**
-     * Load the config file
-     * @param {string} sitePath
-     * @returns {Promise<void>}
-     */
-    loadConfigFile(sitePath: string): Promise<void>;
-    /**
-     * Serve the site based on the options (port and output path)
-     * @param {DoculaOptions} options
-     * @returns {Promise<void>}
-     */
-    serve(options: DoculaOptions): Promise<http.Server>;
-}
-
-export { Docula as default };