From 6a90ecb23861d6278b0579358ba87e1c741ffa29 Mon Sep 17 00:00:00 2001 From: sumansaurabh Date: Thu, 29 Aug 2024 01:16:48 +0530 Subject: [PATCH] feat: Update Vitepress theme configuration for logo and navigation links This commit updates the logo and navigation links in the theme configuration of the Vitepress site. The logo is now a clickable image with a link to "https://www.penify.dev". The "Home" link has been updated to point to "https://www.penify.dev" and a new "Main" link has been added to navigate to the root of the site. These changes enhance the user experience by providing consistent branding and improved navigation options. --- .vitepress/config.mts | 22 +++++++++++++++++++--- docs/code-documentation-with-cli.md | 11 ++++++++--- docs/commit-summary-with-cli.md | 3 +++ docs/common-docstring-format-in-python.md | 6 +++--- docs/semantic-commit-messages.md | 4 ++++ 5 files changed, 37 insertions(+), 9 deletions(-) diff --git a/.vitepress/config.mts b/.vitepress/config.mts index 596f81a..9c7d483 100644 --- a/.vitepress/config.mts +++ b/.vitepress/config.mts @@ -1,4 +1,4 @@ -import { defineConfig } from "vitepress"; +import { defineConfig, HeadConfig } from "vitepress"; // https://vitepress.dev/reference/site-config export default defineConfig({ @@ -6,12 +6,28 @@ export default defineConfig({ title: "Penify", titleTemplate: ":title", description: "Effortlessly generate precise, human like docstrings for GitHub repos with Penify.", + transformHead: ({pageData}) => { + const head: HeadConfig[] = []; + + head.push([ + "meta", + { property: "og:title", content: pageData.frontmatter.title }, + ]); + head.push([ + "meta", + { property: "og:description", content: pageData.frontmatter.description }, + ]); + head.push([ + "keywords", + { property: "og:keywords", content: pageData.frontmatter.keywords }, + ]); + + return head; + }, head: [ ["link", { rel: "icon", href: "/favicon.ico" }], ['meta', { name: 'Penify', content: 'Automated Docstring Generation' }], ['meta', { name: 'keywords', content: 'Penify, docstring, automated docstring, python docstring, LLMs, Generative AI, AI documentation, AI docstring' }], - ['meta', { property: 'og:title', content: 'Penify' }], - ['meta', { property: 'og:description', content: 'Effortlessly generate precise, human like docstrings for GitHub repos with Penify.' }], ['meta', { property: 'og:image', content: '../public/banner.png' }], ['meta', { property: 'og:url', content: 'https://www.penify.dev' }], ['script', { type: 'text/javascript', id: 'hs-script-loader', src: '//js-na1.hs-scripts.com/44651459.js' }], diff --git a/docs/code-documentation-with-cli.md b/docs/code-documentation-with-cli.md index d429aac..c0e2f34 100644 --- a/docs/code-documentation-with-cli.md +++ b/docs/code-documentation-with-cli.md @@ -1,5 +1,8 @@ --- layout: doc +title: "Revolutionize Your Workflow: Automating Code Documentation with Penify-CLI" +description: "Discover how Penify-CLI, an AI-powered command-line tool, can transform your code documentation process. Learn about its features, installation, usage for single files, folders, and Git repositories, and best practices for integrating it into your development workflow to save time and improve code maintainability." +keywords: Penify-CLI, code documentation, automation, AI-powered documentation, developer tools, command-line interface, Git integration, software development, code maintainability, documentation best practices, time-saving tools, continuous integration --- # Automate Code Documentation with Penify-CLI @@ -33,14 +36,16 @@ First things first, let's get Penify-CLI installed: pip install penify-cli ``` -### Setup Environment Variables +## Login -- `PENIFY_API_TOKEN`: You can set this environment variable with your API token to avoid passing it as an argument each time. Here is the [tutorial](https://docs.penify.dev/docs/Creating-API-Keys-in-Penify.html) on setting env variables +You can login using the command ```bash -export PENIFY_API_TOKEN=skl_ai_****** +penify-cli login ``` +or else you can manually set the token by following this tutorial: [tutorial](https://docs.penify.dev/docs/Creating-API-Keys-in-Penify.html) + ## Generating Documentation: Penify-CLI offers multiple ways to generate documentation, catering to different needs: diff --git a/docs/commit-summary-with-cli.md b/docs/commit-summary-with-cli.md index ffb546a..9d76a7c 100644 --- a/docs/commit-summary-with-cli.md +++ b/docs/commit-summary-with-cli.md @@ -1,5 +1,8 @@ --- layout: doc +title: "Streamline Your Git Workflow: Mastering Semantic Commit Messages with Penify-CLI" +description: "Learn how to use Penify-CLI's Commit Summary Generator to automate the creation of meaningful, semantic commit messages. This guide covers installation, usage, customization options, and best practices for integrating Penify-CLI into your Git workflow, helping you save time and improve commit consistency." +keywords: Penify-CLI, commit summary generator, semantic commit messages, Git workflow, automated commits, AI-powered commits, developer tools, version control, commit message consistency, code documentation, time-saving tools, Git best practices --- # Simplify Git Commits with Penify-CLI's Commit Summary Generator diff --git a/docs/common-docstring-format-in-python.md b/docs/common-docstring-format-in-python.md index c33f61b..ac203cc 100644 --- a/docs/common-docstring-format-in-python.md +++ b/docs/common-docstring-format-in-python.md @@ -1,4 +1,5 @@ --- +layout: doc title: "Four Common Docstring format in Python according to PEP-8 Style Guide" description: "Standard Python Docstring according to PEP-8 style guide and they are Google, Epytext, rEST, Numpy" image: "../../public/blogs/docstring.webp" @@ -6,9 +7,8 @@ publishedAt: "2024-02-12" updatedAt: "2024-02-12" author: "Suman Saurabh" isPublished: true -tags: -- Docstring -layout: doc +image: "../../public/blogs/docstring.webp" +keywords: Python docstrings, PEP-8 style guide, PEP-257, Google docstring format, Epytext format, reStructuredText (rST), NumPy docstring format, code documentation, Python best practices, PEP-8 --- # Four Common Docstring format in Python according to PEP-8 Style Guide diff --git a/docs/semantic-commit-messages.md b/docs/semantic-commit-messages.md index 03f0f02..34cc1e7 100644 --- a/docs/semantic-commit-messages.md +++ b/docs/semantic-commit-messages.md @@ -1,5 +1,9 @@ --- layout: doc +title: "The Power of Semantic Commit Messages: Enhancing Code Quality and Collaboration" +description: "Discover how Semantic Commit Messages can transform your development process. Learn the structure, types, and best practices for writing clear, consistent, and meaningful commit messages that improve code quality, automate workflows, and foster better team collaboration." +keywords: Semantic Commit Messages, Git best practices, Code documentation, Version control, Commit conventions, Automated changelog, Code review process, Software development workflow, Commitizen, semantic-release, commitlint + --- # The Power of Semantic Commit Messages: Elevating Your Code Quality and Collaboration