{"id":14065084,"url":"https://github.com/foliant-docs/foliant","last_synced_at":"2026-01-27T01:06:53.418Z","repository":{"id":37493349,"uuid":"52555253","full_name":"foliant-docs/foliant","owner":"foliant-docs","description":"Comprehensive markdown-based documentation toolkit","archived":false,"fork":false,"pushed_at":"2025-11-10T16:32:18.000Z","size":10115,"stargazers_count":175,"open_issues_count":21,"forks_count":8,"subscribers_count":8,"default_branch":"master","last_synced_at":"2025-11-10T18:19:30.392Z","etag":null,"topics":["docs","documentation","docx","latex","markdown","python"],"latest_commit_sha":null,"homepage":"https://foliant-docs.github.io/docs/","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/foliant-docs.png","metadata":{"files":{"readme":"README.md","changelog":"changelog.md","contributing":null,"funding":null,"license":"LICENSE","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":"2016-02-25T20:39:34.000Z","updated_at":"2025-10-27T01:23:05.000Z","dependencies_parsed_at":"2025-05-13T15:36:26.295Z","dependency_job_id":"a3f18f9e-96d8-435b-b9a4-0c2762c7e900","html_url":"https://github.com/foliant-docs/foliant","commit_stats":{"total_commits":797,"total_committers":9,"mean_commits":88.55555555555556,"dds":"0.11041405269761606","last_synced_commit":"9a39e1f6a53b7332548a2a8ec244b06f3b6e612c"},"previous_names":[],"tags_count":30,"template":false,"template_full_name":null,"purl":"pkg:github/foliant-docs/foliant","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/foliant-docs%2Ffoliant","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/foliant-docs%2Ffoliant/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/foliant-docs%2Ffoliant/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/foliant-docs%2Ffoliant/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/foliant-docs","download_url":"https://codeload.github.com/foliant-docs/foliant/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/foliant-docs%2Ffoliant/sbom","scorecard":{"id":406051,"data":{"date":"2025-08-11","repo":{"name":"github.com/foliant-docs/foliant","commit":"9a39e1f6a53b7332548a2a8ec244b06f3b6e612c"},"scorecard":{"version":"v5.2.1-40-gf6ed084d","commit":"f6ed084d17c9236477efd66e5b258b9d4cc7b389"},"score":3.8,"checks":[{"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":"Dangerous-Workflow","score":10,"reason":"no dangerous workflow patterns detected","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":"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":"Token-Permissions","score":0,"reason":"detected GitHub workflow tokens with excessive permissions","details":["Info: topLevel 'contents' permission set to 'read': .github/workflows/python-publish.yml:17","Warn: no topLevel permission defined: .github/workflows/python-test.yml:1","Info: no jobLevel write permissions found"],"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":"Pinned-Dependencies","score":0,"reason":"dependency not pinned by hash detected -- score normalized to 0","details":["Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/python-publish.yml:27: update your workflow using https://app.stepsecurity.io/secureworkflow/foliant-docs/foliant/python-publish.yml/master?enable=pin","Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/python-publish.yml:29: update your workflow using https://app.stepsecurity.io/secureworkflow/foliant-docs/foliant/python-publish.yml/master?enable=pin","Warn: third-party GitHubAction not pinned by hash: .github/workflows/python-publish.yml:33: update your workflow using https://app.stepsecurity.io/secureworkflow/foliant-docs/foliant/python-publish.yml/master?enable=pin","Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/python-publish.yml:60: update your workflow using https://app.stepsecurity.io/secureworkflow/foliant-docs/foliant/python-publish.yml/master?enable=pin","Warn: third-party GitHubAction not pinned by hash: .github/workflows/python-publish.yml:62: update your workflow using https://app.stepsecurity.io/secureworkflow/foliant-docs/foliant/python-publish.yml/master?enable=pin","Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/python-publish.yml:71: update your workflow using https://app.stepsecurity.io/secureworkflow/foliant-docs/foliant/python-publish.yml/master?enable=pin","Warn: third-party GitHubAction not pinned by hash: .github/workflows/python-publish.yml:76: update your workflow using https://app.stepsecurity.io/secureworkflow/foliant-docs/foliant/python-publish.yml/master?enable=pin","Warn: third-party GitHubAction not pinned by hash: .github/workflows/python-publish.yml:81: update your workflow using https://app.stepsecurity.io/secureworkflow/foliant-docs/foliant/python-publish.yml/master?enable=pin","Warn: third-party GitHubAction not pinned by hash: .github/workflows/python-publish.yml:91: update your workflow using https://app.stepsecurity.io/secureworkflow/foliant-docs/foliant/python-publish.yml/master?enable=pin","Warn: third-party GitHubAction not pinned by hash: .github/workflows/python-publish.yml:101: update your workflow using https://app.stepsecurity.io/secureworkflow/foliant-docs/foliant/python-publish.yml/master?enable=pin","Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/python-test.yml:13: update your workflow using https://app.stepsecurity.io/secureworkflow/foliant-docs/foliant/python-test.yml/master?enable=pin","Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/python-test.yml:15: update your workflow using https://app.stepsecurity.io/secureworkflow/foliant-docs/foliant/python-test.yml/master?enable=pin","Warn: third-party GitHubAction not pinned by hash: .github/workflows/python-test.yml:19: update your workflow using https://app.stepsecurity.io/secureworkflow/foliant-docs/foliant/python-test.yml/master?enable=pin","Info:   0 out of   6 GitHub-owned GitHubAction dependencies pinned","Info:   0 out of   7 third-party GitHubAction dependencies pinned"],"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":"Vulnerabilities","score":10,"reason":"0 existing vulnerabilities detected","details":null,"documentation":{"short":"Determines if the project has open, known unfixed vulnerabilities.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#vulnerabilities"}},{"name":"License","score":10,"reason":"license file detected","details":["Info: project has a license file: LICENSE:0","Info: FSF or OSI recognized license: MIT License: LICENSE:0"],"documentation":{"short":"Determines if the project has defined a license.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#license"}},{"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":"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":-1,"reason":"internal error: error during branchesHandler.setup: internal error: githubv4.Query: Resource not accessible by integration","details":null,"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":"SAST","score":0,"reason":"SAST tool is not run on all commits -- score normalized to 0","details":["Warn: 0 commits out of 5 are checked with a SAST tool"],"documentation":{"short":"Determines if the project uses static code analysis.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#sast"}}]},"last_synced_at":"2025-08-18T21:17:27.031Z","repository_id":37493349,"created_at":"2025-08-18T21:17:27.031Z","updated_at":"2025-08-18T21:17:27.031Z"},"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":28794642,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-01-26T21:49:50.245Z","status":"ssl_error","status_checked_at":"2026-01-26T21:48:29.455Z","response_time":59,"last_error":"SSL_read: 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":["docs","documentation","docx","latex","markdown","python"],"created_at":"2024-08-13T07:04:17.336Z","updated_at":"2026-01-27T01:06:53.392Z","avatar_url":"https://github.com/foliant-docs.png","language":"Python","funding_links":[],"categories":["Python"],"sub_categories":[],"readme":"[![PyPI](https://img.shields.io/pypi/v/foliant.svg)](https://pypi.org/project/foliant/)\n[![Travis](https://img.shields.io/travis/foliant-docs/foliant.svg)](https://travis-ci.org/foliant-docs/foliant)\n[![codecov](https://codecov.io/gh/foliant-docs/foliant/branch/develop/graph/badge.svg)](https://codecov.io/gh/foliant-docs/foliant)\n\n![](img/foliant.gif)\n\n# Foliant\n\nFoliant is an all-in-one single-source documentation authoring tool. It lets you produce standalone documents in **pdf** and **docx**, build **static websites** and upload pages to **Confluence**, all from single Markdown source.\n\nFoliant is a higher order tool, which means it uses other programs to do its job. For building pdf and docx, it can use [Pandoc](https://pandoc.org/) or [md-to-pdf](https://github.com/simonhaenisch/md-to-pdf), for websites [MkDocs](https://www.mkdocs.org/), [Aglio](https://github.com/danielgtaylor/aglio) or [Slate](https://github.com/slatedocs/slate).\n\nFoliant preprocessors let you reuse parts of your documents, show and hide content with flags, render diagrams from text, and much more.\n\nFoliant is highly extensible, so if it lacks some functions or output formats you can always make a plugin for it or request one from our team.\n\n[Foliant Documentation](https://foliant-docs.github.io/docs/) website.\n\n## Installation\n\nFoliant is written in Python and requires Python 3.6.\n\nTo install Foliant, use pip:\n\n```shell\n$ pip install foliant\n```\n\nBackends, extensions, and preprocessors are installed with pip as well. For the Quickstart, you'll need the [MkDocs backend](https://github.com/foliant-docs/foliantcontrib.mkdocs) and [init CLI extension](https://github.com/foliant-docs/foliantcontrib.init):\n\n```shell\n$ pip install foliantcontrib.mkdocs foliantcontrib.init\n```\n\nTo build pdf and docx, install the [Pandoc backend](https://github.com/foliant-docs/foliantcontrib.pandoc):\n\n```shell\n$ pip install foliantcontrib.pandoc\n```\n\n\n## Quickstart\n\n1. Create a new project:\n\n```shell\n$ foliant init\nEnter the project name: Hello Foliant\n✓ Generating Foliant project\n─────────────────────\nProject \"Hello Foliant\" created in /path/to/hello-foliant\n```\n\nThis command creates a basic Foliant project:\n\n```\nhello-foliant/\n├── foliant.yml\n└── src\n    └── index.md\n\n1 directory, 2 files\n```\n\n`foliant.yml` is the project config file, `src` is the directory that contains the project source files (initially, just one file `index.md`).\n\n2. Build a website from the newly created project:\n\n```shell\n$ foliant make site -p hello-foliant/\n✓ Parsing config\n✓ Applying preprocessor mkdocs\n✓ Making site with MkDocs\n─────────────────────\nResult: Hello_Foliant-0.1.0-2017-11-24.mkdocs\n```\n\n3. Run a local webserver in the site directory and see the site in your browser:\n\n```shell\n$ cd Hello_Foliant-0.1.0-2017-11-24.mkdocs\n$ python -m http.server\nServing HTTP on 0.0.0.0 port 8000 (http://0.0.0.0:8000/) ...\n```\n\n4. Build a standalone pdf document from the project:\n\n```shell\n$ foliant make pdf -p hello-foliant/\n✓ Parsing config\n✓ Applying preprocessor mkdocs\n✓ Making pdf with Pandoc\n─────────────────────\nResult: Hello_Foliant-0.1.0-2017-11-24.pdf\n```\n\n\u003e **Important**\n\u003e\n\u003e To produce pdf, Pandoc first converts Markdown to tex and then coverts it to pdf. To convert pdf \u003e from tex, you need to have a LaTeX distribution installed:\n\u003e\n\u003e -   [MacTeX](http://tug.org/mactex/) for macOS\n\u003e -   [MikTeX](https://miktex.org/) for Windows\n\u003e -   [TeXLive](https://tug.org/texlive/) for Linux\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ffoliant-docs%2Ffoliant","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Ffoliant-docs%2Ffoliant","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ffoliant-docs%2Ffoliant/lists"}