Skip to content

Commit

Permalink
Documentation updated
Browse files Browse the repository at this point in the history
  • Loading branch information
darsan-in committed Dec 6, 2024
1 parent 392baaa commit 504f988
Show file tree
Hide file tree
Showing 35 changed files with 3,061 additions and 1,000 deletions.
1 change: 1 addition & 0 deletions .prettierignore
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
*.mdx
2 changes: 1 addition & 1 deletion LICENSE.md
Original file line number Diff line number Diff line change
Expand Up @@ -630,7 +630,7 @@ attach them to the start of each source file to most effectively state
the exclusion of warranty; and each file should have at least the
"copyright" line and a pointer to where the full notice is found.

This repository is a code base of website of Hawk JS Documentations (API & CLI references)
This repository is a code base of website of Hawk.js Documentations (API & CLI references)
Copyright (C) 2024 PRIYADARSAN (iamspdarsan@gmail.com)

This program is free software: you can redistribute it and/or modify
Expand Down
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
<div align="center">

# Hawk JS API references - Website
# Hawk.js API references - Website

---

Expand Down
2 changes: 1 addition & 1 deletion dev/gen-favicons.mjs
Original file line number Diff line number Diff line change
Expand Up @@ -75,7 +75,7 @@ export async function generateFavicons({

generateFavicons({
metaDesc:
"Hawk JS is the ultimate tool for web developers and SEO enthusiasts. Find out how it can automates your SEO process by effortlessly submitting your sitemap, ensuring search engines like Google, Bing, Yahoo, DuckDuckGo, Yandex, Naver, Seznam.cz, and Yep stay updated with your latest content.",
"Hawk.js is the ultimate tool for web developers and SEO enthusiasts. Find out how it can automates your SEO process by effortlessly submitting your sitemap, ensuring search engines like Google, Bing, Yahoo, DuckDuckGo, Yandex, Naver, Seznam.cz, and Yep stay updated with your latest content.",
version: "1.5.1",
appName: "Hawk.js Documentation",
});
2 changes: 1 addition & 1 deletion package.json
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
{
"name": "hawk-js-docsite",
"version": "0.2b",
"description": "Hawk JS API References",
"description": "Hawk.js API References",
"scripts": {
"dev": "next dev",
"build": "next build",
Expand Down
13 changes: 8 additions & 5 deletions pages/docs/_meta.ts
Original file line number Diff line number Diff line change
Expand Up @@ -10,14 +10,14 @@ export default {
"getting-started-with-hawk-js": {
title: "Getting Started",
},
"effective-indexing-with-hawk-js": {
title: "Hawk Stategies",
},
"hawk-js-configuration-settings-guide": {
title: "Configurations",
},
"obtaining-google-credentials-for-hawk-js": {
title: "Credentials 🔑🚨",
"effective-indexing-with-hawk-js": {
title: "Strategy",
},
credentials: {
title: "Credentials",
},
"enhancing-seo-with-hawk-js-cli": {
title: "CLI References",
Expand All @@ -31,6 +31,9 @@ export default {
"hawk-js-demonstration-repository": {
title: "Demonstration",
},
"ci-cd-with-hawkjs": {
title: "CI/CD",
},
"comprehensive-faq-for-hawk-js": {
title: "FAQ",
},
Expand Down
29 changes: 29 additions & 0 deletions pages/docs/ci-cd-with-hawkjs.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,29 @@


# Continuous Integration with Hawk.js

Hawk.js integrates seamlessly into your CI/CD pipelines on platforms like **GitHub Actions**, **GitLab CI**, and **Jenkins**, enabling automated sitemap generation and search engine submission during your deployment process.

### What Does Hawk.js Do in CI/CD?

1. **Build Your Website**: Generate the deployable version of your site (e.g., static site generators, Next.js apps).
2. **Generate Sitemaps**: Create `sitemap.xml` and `robots.txt` using Hawk.js.
3. **Trigger Search Engines**: Notify search engines using these strategies:
- **IndexNow**: For Bing, Yahoo, Yandex, and other IndexNow-compatible engines.
- **Google Webmaster API**: Submit and manage sitemaps via Google Search Console.
- **Google Indexing API**: Notify Google about job postings or live stream updates.
4. **Optional**: Generate sitemaps only, without triggering search engines.

### Platform-Specific Workflows
While each CI/CD platform uses different syntax, the core operations are identical.
- **[GitHub Actions](/docs/ci-cd-with-hawkjs/github-action)**: Workflow examples for integrating Hawk.js in GitHub repositories.
- **[GitLab CI](/docs/ci-cd-with-hawkjs/gitlab-ci)**: Pipeline definitions tailored for GitLab environments.
- **[Jenkins](/docs/ci-cd-with-hawkjs/jenkins)**: Flexible pipeline scripts for various deployment scenarios.

Each page provides **four customizable workflows**:
1. **IndexNow Strategy**: Notify IndexNow-compatible engines.
2. **Google Webmaster**: Upload sitemaps to Google Search Console.
3. **Google Indexing API**: Directly notify Google about page updates.
4. **Sitemap Generation Only**: Generate the sitemap without triggering submissions.

Explore platform-specific pages for detailed workflow templates and step-by-step guidance.
5 changes: 5 additions & 0 deletions pages/docs/ci-cd-with-hawkjs/_meta.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
export default {
"github-action": {
title: "Github Action",
},
};
Loading

0 comments on commit 504f988

Please sign in to comment.