From a5ffaf3054a38e4159a711c08f3e7cc3c662795a Mon Sep 17 00:00:00 2001 From: jzonthemtn <jeff.zemerick@philterd.ai> Date: Wed, 23 Oct 2024 18:38:46 -0400 Subject: [PATCH] #11 Working on moving docs. --- docs/docs/index.md | 2 +- docs/mkdocs.yml | 8 ++++++++ docs/requirements.txt | 1 + 3 files changed, 10 insertions(+), 1 deletion(-) diff --git a/docs/docs/index.md b/docs/docs/index.md index c187220..4ea64aa 100644 --- a/docs/docs/index.md +++ b/docs/docs/index.md @@ -1,6 +1,6 @@ # Philter -> This documentation applies to Philter 2.4.0. If you are upgrading to this version see [Upgrading](upgrading.md). +> This documentation applies to Philter {$ version }. If you are upgrading to this version see [Upgrading](upgrading.md). Philter is an API-based application that finds and redacts sensitive information, such as protected health information (PHI) and personally identifiable information (PII), and user-defined sensitive information from natural language text. Philter is ideal for usage in text processing pipelines where sensitive information needs removed, encrypted, or redacted from the text. diff --git a/docs/mkdocs.yml b/docs/mkdocs.yml index 76b0ad3..d7fc669 100644 --- a/docs/mkdocs.yml +++ b/docs/mkdocs.yml @@ -5,6 +5,11 @@ edit_uri: tree/main/docs/docs copyright: Copyright 2024 Philterd, LLC site_author: philterd site_description: User guide for Philter, the open source PII/PHI redaction engine. +plugins: + - markdownextradata: + jinja_options: + variable_start_string: "{$" + variable_end_string: "}" theme: name: material logo: img/philterd.png @@ -16,10 +21,13 @@ theme: - navigation.expand - navigation.footer extra: + version: 2.4.0 homepage: https://www.philterd.ai social: - icon: fontawesome/brands/linkedin link: https://www.linkedin.com/company/philterd/ + - icon: fontawesome/brands/github + link: https://www.github.com/philterd/ analytics: provider: google property: G-SQ49ZGCWT2 diff --git a/docs/requirements.txt b/docs/requirements.txt index 9a8a4ca..1430e9c 100644 --- a/docs/requirements.txt +++ b/docs/requirements.txt @@ -1,2 +1,3 @@ mkdocs mkdocs-material +mkdocs-markdownextradata-plugin \ No newline at end of file