Skip to content

Commit

Permalink
feat: Update Vitepress theme configuration for logo and navigation links
Browse files Browse the repository at this point in the history
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.
  • Loading branch information
sumansaurabh committed Aug 28, 2024
1 parent af627f0 commit 6a90ecb
Show file tree
Hide file tree
Showing 5 changed files with 37 additions and 9 deletions.
22 changes: 19 additions & 3 deletions .vitepress/config.mts
Original file line number Diff line number Diff line change
@@ -1,17 +1,33 @@
import { defineConfig } from "vitepress";
import { defineConfig, HeadConfig } from "vitepress";

// https://vitepress.dev/reference/site-config
export default defineConfig({
lang: "en-US",
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' }],
Expand Down
11 changes: 8 additions & 3 deletions docs/code-documentation-with-cli.md
Original file line number Diff line number Diff line change
@@ -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
Expand Down Expand Up @@ -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:
Expand Down
3 changes: 3 additions & 0 deletions docs/commit-summary-with-cli.md
Original file line number Diff line number Diff line change
@@ -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
Expand Down
6 changes: 3 additions & 3 deletions docs/common-docstring-format-in-python.md
Original file line number Diff line number Diff line change
@@ -1,14 +1,14 @@
---
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"
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
Expand Down
4 changes: 4 additions & 0 deletions docs/semantic-commit-messages.md
Original file line number Diff line number Diff line change
@@ -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
Expand Down

0 comments on commit 6a90ecb

Please sign in to comment.