merge: branch 'main' of https://github.com/cppdoc-cc/cppdoc

Author: std-microblock

.commitlintrc.mjs

@@ -0,0 +1,42 @@
+/** @type { import('cz-git').UserConfig } */
+export default {
+  rules: {
+    // @see: https://commitlint.js.org/#/reference-rules
+  },
+  prompt: {
+    alias: { fd: "docs: fix typos" },
+    useEmoji: false,
+    emojiAlign: "center",
+    useAI: false,
+    aiNumber: 1,
+    themeColorCode: "",
+    scopes: ["docs:c", "docs:cpp", "docs:development", "components:*"],
+    allowCustomScopes: true,
+    allowEmptyScopes: true,
+    customScopesAlign: "bottom",
+    customScopesAlias: "custom",
+    emptyScopesAlias: "empty",
+    upperCaseSubject: null,
+    markBreakingChangeMode: false,
+    allowBreakingChanges: ["feat", "fix"],
+    breaklineNumber: 100,
+    breaklineChar: "|",
+    skipQuestions: [],
+    issuePrefixes: [
+      { value: "closed", name: "closed:   ISSUES has been processed" },
+    ],
+    customIssuePrefixAlign: "top",
+    emptyIssuePrefixAlias: "skip",
+    customIssuePrefixAlias: "custom",
+    allowCustomIssuePrefix: true,
+    allowEmptyIssuePrefix: true,
+    confirmColorize: true,
+    scopeOverrides: undefined,
+    defaultBody: "",
+    defaultIssues: "",
+    defaultScope: "",
+    defaultSubject: "",
+    enableMultipleScopes: true,
+    scopeEnumSeparator: ",",
+  },
+};

.gitignore

@@ -7,6 +7,8 @@ dist/
 # dependencies
 node_modules/
 yarn.lock
+pnpm-lock.yaml
+pnpm-workspace.yaml
 
 # logs
 npm-debug.log*

.prettierrc

@@ -1 +1,6 @@
-{}
+{
+  "tabWidth": 2,
+  "singleQuote": false,
+  "trailingComma": "es5",
+  "semi": true
+}

README.md

@@ -5,6 +5,13 @@ An open documentation for the C/C++ programming languages and their standard lib
 > [!TIP]
 > Currently CppDoc community members are working hard on migrating [cppreference](https://en.cppreference.com/index.html) pages to CppDoc. You’re more than welcomed to join us if you want to help!
 
+<a href="https://discord.gg/TYgbKkM4" target="_blank">
+  <img src="https://img.shields.io/badge/Discord-5865F2?style=for-the-badge&logo=discord&logoColor=white" alt="Discord server" />
+</a>
+<a href="https://t.me/+Rck2PsPCxBZkZWE1" target="_blank">
+  <img src="https://img.shields.io/badge/Telegram-2CA5E0?style=for-the-badge&logo=telegram&logoColor=white" alt="Telegram group" />
+</a>
+
 ## Quick Start
 
 Clone the project to your local:

src/lib/doc-index.ts

@@ -25,7 +25,7 @@ async function buildKeyIndex(): Promise<Map<string, string>> {
 
       if (index.has(key)) {
         console.warn(
-          `Key "${key}" is already assigned to "${index.get(key)}", cannot reassign it to "${doc.id}"`,
+          `Key "${key}" is already assigned to "${index.get(key)}", cannot reassign it to "${doc.id}"`
         );
         continue;
       }

src/lib/revision.ts

@@ -38,7 +38,7 @@ export function getLanguageFromRevision(rev: CxxRevision): Language {
 
 export function getRevisions(
   lang: Language,
-  range?: RevisionRange,
+  range?: RevisionRange
 ): CxxRevision[] {
   const revisions: CxxRevision[] = lang === "C++" ? CPP_REVISIONS : C_REVISIONS;
 
@@ -52,7 +52,7 @@ export function getRevisions(
 
 export function compareRevisions(
   lhs: CxxRevision,
-  rhs: CxxRevision,
+  rhs: CxxRevision
 ): number | undefined {
   const lhsLang = getLanguageFromRevision(lhs);
   const rhsLang = getLanguageFromRevision(rhs);
@@ -67,7 +67,7 @@ export function compareRevisions(
 
 export function isRevisionInRange(
   rev: CxxRevision,
-  range: RevisionRange,
+  range: RevisionRange
 ): boolean | undefined {
   const lang = getLanguageFromRevision(rev);
   if (range.since && lang !== getLanguageFromRevision(range.since)) {