{"id":16325537,"url":"https://github.com/nixinova/wikity","last_synced_at":"2026-02-15T08:01:33.318Z","repository":{"id":104194444,"uuid":"352001814","full_name":"Nixinova/Wikity","owner":"Nixinova","description":"Compile wikitext to HTML: wikitext as a templating language.","archived":false,"fork":false,"pushed_at":"2024-11-14T07:08:02.000Z","size":263,"stargazers_count":15,"open_issues_count":2,"forks_count":2,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-10-20T00:29:54.972Z","etag":null,"topics":["compiler","eleventy","eleventy-plugin","html-template","nixinova","template-language","templating-language","wikitext","wikitext-parser"],"latest_commit_sha":null,"homepage":"","language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"isc","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/Nixinova.png","metadata":{"files":{"readme":"readme.md","changelog":"changelog.md","contributing":null,"funding":null,"license":"license.md","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null,"notice":null,"maintainers":null,"copyright":null,"agents":null,"dco":null,"cla":null}},"created_at":"2021-03-27T06:40:55.000Z","updated_at":"2025-09-19T00:22:00.000Z","dependencies_parsed_at":null,"dependency_job_id":"f2b627e1-f882-4675-9e3c-14f4716d16f8","html_url":"https://github.com/Nixinova/Wikity","commit_stats":{"total_commits":6,"total_committers":1,"mean_commits":6.0,"dds":0.0,"last_synced_commit":"62d26c7aba9a82146a5d0572330cbbe2dbd77995"},"previous_names":[],"tags_count":13,"template":false,"template_full_name":null,"purl":"pkg:github/Nixinova/Wikity","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Nixinova%2FWikity","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Nixinova%2FWikity/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Nixinova%2FWikity/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Nixinova%2FWikity/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/Nixinova","download_url":"https://codeload.github.com/Nixinova/Wikity/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Nixinova%2FWikity/sbom","scorecard":{"id":102018,"data":{"date":"2025-08-11","repo":{"name":"github.com/Nixinova/Wikity","commit":"96b079b5701a58031a81d30b2552929f910fe0be"},"scorecard":{"version":"v5.2.1-40-gf6ed084d","commit":"f6ed084d17c9236477efd66e5b258b9d4cc7b389"},"score":2.9,"checks":[{"name":"Dangerous-Workflow","score":-1,"reason":"no workflows found","details":null,"documentation":{"short":"Determines if the project's GitHub Action workflows avoid dangerous patterns.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#dangerous-workflow"}},{"name":"Code-Review","score":0,"reason":"Found 0/30 approved changesets -- score normalized to 0","details":null,"documentation":{"short":"Determines if the project requires human code review before pull requests (aka merge requests) are merged.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#code-review"}},{"name":"SAST","score":0,"reason":"no SAST tool detected","details":["Warn: no pull requests merged into dev branch"],"documentation":{"short":"Determines if the project uses static code analysis.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#sast"}},{"name":"Token-Permissions","score":-1,"reason":"No tokens found","details":null,"documentation":{"short":"Determines if the project's workflows follow the principle of least privilege.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#token-permissions"}},{"name":"Packaging","score":-1,"reason":"packaging workflow not detected","details":["Warn: no GitHub/GitLab publishing workflow detected."],"documentation":{"short":"Determines if the project is published as a package that others can easily download, install, easily update, and uninstall.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#packaging"}},{"name":"Maintained","score":0,"reason":"0 commit(s) and 0 issue activity found in the last 90 days -- score normalized to 0","details":null,"documentation":{"short":"Determines if the project is \"actively maintained\".","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#maintained"}},{"name":"Binary-Artifacts","score":10,"reason":"no binaries found in the repo","details":null,"documentation":{"short":"Determines if the project has generated executable (binary) artifacts in the source repository.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#binary-artifacts"}},{"name":"Pinned-Dependencies","score":-1,"reason":"no dependencies found","details":null,"documentation":{"short":"Determines if the project has declared and pinned the dependencies of its build process.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#pinned-dependencies"}},{"name":"CII-Best-Practices","score":0,"reason":"no effort to earn an OpenSSF best practices badge detected","details":null,"documentation":{"short":"Determines if the project has an OpenSSF (formerly CII) Best Practices Badge.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#cii-best-practices"}},{"name":"Security-Policy","score":0,"reason":"security policy file not detected","details":["Warn: no security policy file detected","Warn: no security file to analyze","Warn: no security file to analyze","Warn: no security file to analyze"],"documentation":{"short":"Determines if the project has published a security policy.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#security-policy"}},{"name":"Fuzzing","score":0,"reason":"project is not fuzzed","details":["Warn: no fuzzer integrations found"],"documentation":{"short":"Determines if the project uses fuzzing.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#fuzzing"}},{"name":"License","score":10,"reason":"license file detected","details":["Info: project has a license file: license.md:0","Info: FSF or OSI recognized license: ISC License: license.md:0"],"documentation":{"short":"Determines if the project has defined a license.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#license"}},{"name":"Signed-Releases","score":-1,"reason":"no releases found","details":null,"documentation":{"short":"Determines if the project cryptographically signs release artifacts.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#signed-releases"}},{"name":"Branch-Protection","score":0,"reason":"branch protection not enabled on development/release branches","details":["Warn: branch protection not enabled for branch 'main'"],"documentation":{"short":"Determines if the default and release branches are protected with GitHub's branch protection settings.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#branch-protection"}},{"name":"Vulnerabilities","score":9,"reason":"1 existing vulnerabilities detected","details":["Warn: Project is vulnerable to: GHSA-v6h2-p8h4-qcjw"],"documentation":{"short":"Determines if the project has open, known unfixed vulnerabilities.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#vulnerabilities"}}]},"last_synced_at":"2025-08-15T10:20:29.379Z","repository_id":104194444,"created_at":"2025-08-15T10:20:29.379Z","updated_at":"2025-08-15T10:20:29.379Z"},"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":29473364,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-02-15T06:58:05.414Z","status":"ssl_error","status_checked_at":"2026-02-15T06:58:05.085Z","response_time":118,"last_error":"SSL_connect returned=1 errno=0 peeraddr=140.82.121.5:443 state=error: unexpected eof while reading","robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":false,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["compiler","eleventy","eleventy-plugin","html-template","nixinova","template-language","templating-language","wikitext","wikitext-parser"],"created_at":"2024-10-10T23:05:16.899Z","updated_at":"2026-02-15T08:01:33.273Z","avatar_url":"https://github.com/Nixinova.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"[![Latest version](https://img.shields.io/github/v/release/Nixinova/Wikity?label=latest%20version\u0026style=flat-square)](https://github.com/Nixinova/Wikity/releases)\n[![Last updated](https://img.shields.io/github/release-date/Nixinova/Wikity?label=updated\u0026style=flat-square)](https://github.com/Nixinova/Wikity/releases)\n[![npm downloads](https://img.shields.io/npm/dt/wikity?logo=npm)](https://www.npmjs.com/package/wikity)\n\n# Wikity\n\n**Wikity** is a tool that allows you to use Wikitext (used by Wikipedia, Fandom, etc) as a templating language to create HTML pages.\n\nThis package comes with built-in support for compilation using [Eleventy](https://11ty.dev).\n\n## Exemplar\n\nSee the `example` folder for a template on making your own wiki site!\n\n## Install\n\nWikity is available [on npm](https://www.npmjs.com/package/wikity).\nInstall locally to use in a Node package or install globally for use from the command-line.\n\n| Local install        | Global install          |\n| -------------------- | ----------------------- |\n| `npm install wikity` | `npm install -g wikity` |\n\n## API\n\n### Node\n\n- `wikity.compile(folder?: string, options?: object): void`\n  - Compile all Wikitext (`.wiki`) files from an input folder (defaults to the current directory, `.`) into HTML.\n- `wikity.parse(input: string, options?: object): string`\n  - Parse raw wikitext input into HTML.\n\n- **Options**:\n  - `eleventy: boolean = false`\n    - Whether [front matter](https://www.11ty.dev/docs/data-frontmatter/) will be added to the outputted HTML for Eleventy to read (default: `false`).\n      (**This parameter *must* be set to `true` if you want to use this with Eleventy.**)\n  - `outputFolder: string`\n    - *Used only with `compile()`.*\n    - Where outputted HTML files shall be placed.\n    - Default: `'wikity-out'`.\n  - `templatesFolder: string`\n    - What folder to place templates in.\n    - Default: `'templates'`.\n  - `imagesFolder: string`\n    - What folder to place images in.\n    - Default: `'images'`.\n  - `defaultStyles: boolean`\n    - *Used only with `compile()`.*\n    - Whether to use default wiki styling.\n    - Default: to `true` when called from `compile()` and `false` when called from `parse()`.\n  - `customStyles: string`\n    - *Used only with `compile()`.*\n    - Custom CSS styles to add to the wiki pages.\n    - Default: empty (`''`).\n\n#### Example\n\n```js\nconst wikity = require('wikity');\n\n// compile all .wiki files inside this directory\nwikity.compile();\n\n// parse wikitext from an input string\nlet html = wikity.parse(`'''bold''' [[link|text]]`); // \u003cb\u003ebold\u003c/b\u003e \u003ca href=\"link\"...\u003etext\u003c/a\u003e\n```\n\n#### As an Eleventy plugin\n\nUse Wikity along with Eleventy to have all your wiki files compiled during the build process:\n\n```js\n// .eleventy.js (eleventy's configuration file)\nconst wikity = require('wikity');\nmodule.exports = function (eleventyConfig) {\n    const rootFolder = 'src';\n    const templatesFolder = 'templates', imagesFolder = 'images'; // defaults; relative to root folder\n    const outputFolder = 'wikity-out'; // default\n    const wikityOptions = { eleventy: true, templatesFolder, imagesFolder, outputFolder };\n    const wikityPlugin = () =\u003e wikity.compile(rootFolder, wikityOptions);\n    eleventyConfig.addPlugin(wikityPlugin);\n    eleventyConfig.addPassthroughCopy({ 'src/images': 'wiki/' + imagesFolder }); // Eleventy does not pass through images by default\n}\n```\n\nThe above will use the following file structure (with some example wiki files given):\n\n- `src/`\n  - `templates/`: Directory for wiki templates (called like `{{this}}`)\n  - `images/`: Directory to place images (called like `[[File:this]]`)\n  - `Index.wiki`: Example file\n  - `Other_Page.wiki`: Example other file\n- `wikity-out/`: File templates compiled from the `.wiki` files (add this to `.gitignore`)\n- `wiki/`: Output HTML files compiled from `wikity-out/` (add this to `.gitignore`)\n\n(View the above starting at the URL path `/wiki/` when ran in an HTTP server.)\n\n### Command-line\n```cmd\n$ wikity help\nDisplay a help message\n$ wikity compile [\u003cfolder\u003e] [-o \u003cfolder\u003e] [-t \u003cfolder\u003e] [-e] [-d]\nCompile Wikity with various options\n$ wikity parse \u003cinput\u003e\nParse raw input into HTML\n$ wikity version\nDisplay the latest version of Wikity\n```\n\n## Usage\n\nUse [Wikitext](https://en.wikipedia.org/wiki/Help:Wikitext) (file extension `.wiki`) to create your pages.\n\nAny wiki templates (called using `{{template name}}`) must be inside the `templates/` folder by default.\nAny files must be inside the `images/` folder by default.\nYour wikitext (`*.wiki`) files go in the root directory by default.\n\n### Wiki markup\n\n| Markup                           | Preview                                   |\n| -------------------------------- | ----------------------------------------- |\n| `'''bold'''`                     | **bold**                                  |\n| `''italic''`                     | *italic*                                  |\n| `'''''bold italic'''''`          | ***bold italic***                         |\n| ` ``code`` `                     | `code`                                    |\n| ` ```code block``` `             | \u003cpre\u003ecode block\u003c/pre\u003e                     |\n| `=heading=`                      | \u003cbig\u003e\u003cbig\u003e\u003cbig\u003eheading\u003c/big\u003e\u003c/big\u003e\u003c/big\u003e  |\n| `==subheading==`                 | \u003cbig\u003e\u003cbig\u003esubheading\u003c/big\u003e\u003c/big\u003e          |\n| `*bulleted`                      | \u003cul\u003e\u003cli\u003ebulleted\u003c/li\u003e\u003c/ul\u003e                |\n| `**sub-bulleted`                 | \u003cul\u003e\u003cul\u003e\u003cli\u003esub-bulleted\u003c/li\u003e\u003c/ul\u003e\u003c/ul\u003e   |\n| `#numbered`                      | \u003col\u003e\u003cli\u003enumbered\u003c/li\u003e\u003c/ol\u003e                |\n| `##sub-numbered`                 | \u003col\u003e\u003col\u003e\u003cli\u003esub-numbered\u003c/li\u003e\u003c/ol\u003e\u003c/ol\u003e   |\n| `;term`                          | \u003cdt\u003e**term**\u003c/dt\u003e                         |\n| `:definition`                    | \u003cdd\u003e\u0026emsp;definition\u003c/dd\u003e                 |\n| `\u003cref\u003eText\u003c/ref\u003e`                | \u003csup id=cite-1\u003e[[1]](#ref-1)\u003c/sup\u003e        |\n| `\u003creferences/\u003e`                  | 1. \u003ca id=ref-1\u003e[↑](#cite-1)\u003c/a\u003e Text      |\n| `[[internal link]]`              | [internal link](#internal_link)           |\n| `[[link\\|display text]]`         | [display text](#link)                     |\n| `[external-link]`                | [[1]](#external-link)                     |\n| `[external-link display text]`   | [display text](#external-link)            |\n| `[[File:Example.png\\|Caption.]]` | ![Caption](Example.png)                   |\n| `{{tp name}}`                    | *(contents of `templates/tp_name.wiki`)*  |\n| `{{tp name\\|arg=val}}`           | *(ditto but `{{{arg}}}` is set to 'val')* |\n| `{{{arg}}}`                      | *(value given by template)*               |\n| `{{{arg\\|default val}}}`         | *(ditto but 'default val' if unset)*      |\n| `{\\| style=\"margin:1em\"`         | *table opening*                           |\n| `! Cell heading`                 | **Cell heading**                          |\n| `\\|- class=\"new-row\"`            | *new table row*                           |\n| `\\| Cell content`                | Cell content                              |\n| `\\|}`                            | *table closing*                           |\n| `{{#if:non-empty-string\\|text}}` | text                                      |\n| `{{#ifeq:1\\|2\\|true\\|false}}`    | false                                     |\n| `{{#vardefine:varname\\|text}}`   | *(saved to memory)*                       |\n| `{{#var:varname}}`               | text *(from memory)*                      |\n| `{{#var:varname\\|default val}}`  | *(ditto but 'default val' if unset)*      |\n| `{{#switch:a\\|a=1\\|b=2\\|c=3}}`   | 1                                         |\n| `{{#time:dd/mm/yy\\|2021-03-28}}` | 28/03/21                                  |\n| `{{#lc:TEXT}}`                   | text                                      |\n| `{{#ucfirst:text}}`              | Text                                      |\n| `{{#len:12345}}`                 | 5                                         |\n| `{{#sub:string\\|2\\|4}}`          | ring                                      |\n| `{{#pos:text\\|x}}`               | 2                                         |\n| `{{#padleft:text\\|5\\|_}}`        | _text                                     |\n| `{{#padright:msg\\|5\\|_}}`        | msg__                                     |\n| `{{#replace:Message\\|e\\|3}}`     | M3ssag3                                   |\n| `{{#explode:A-B-C-D\\|-\\|2}}`     | C                                         |\n| `{{#urlencode:t e x t}}`         | t%20e%20x%20t                             |\n| `{{#urldecode:a%20b%27c}}`       | a b'c                                     |\n| `{{#ev:youtube\\|dQw4w9WgXcQ}}`   | *(YouTube embed)*                         |\n| `\u003cnoinclude\u003eNo\u003c/noinclude\u003e`      | *(blank outside a template)*              |\n| `\u003conlyinclude\u003eYes\u003c/onlyinclude\u003e` | Yes                                       |\n| `\u003cincludeonly\u003eYes\u003c/includeonly\u003e` | Yes *(blank inside a template)*           |\n| `\u003cnowiki\u003e[[no link]]\u003c/nowiki\u003e`   | [[no link]]                               |\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fnixinova%2Fwikity","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fnixinova%2Fwikity","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fnixinova%2Fwikity/lists"}