Git Product home page Git Product logo

folini / page-auditor Goto Github PK

View Code? Open in Web Editor NEW
7.0 1.0 3.0 9.87 MB

"Page Auditor for Technical SEO" is an open source Google Chrome Extension created by Franco Folini. Once you added Page Auditor to your browser it will let you explore and analyze Structured Data, JavaScript scripts, Meta-Tags, Robots.txt and Sitemap.xml files from any webpage. All these elements are critical to improve the on-page SEO.

License: Other

JavaScript 2.53% TypeScript 75.68% HTML 0.62% Less 21.15% Shell 0.03%
typescript technical-seo google-chrome-extention digital-marketing meta-tags structured-data robots-txt sitemap-xml on-page-analyze

page-auditor's Introduction

Page Auditor for Technical SEO

Page Auditor for Technical SEO is an open source free_Google Chrome Extension_ created by Franco Folini to explore and analyze the main on-page technical SEO features of any web page.

Purpose

Page Auditor is a free Microsoft Edge and Google Chrome Extension based on open source code. It can be installed on any Microsoft Edge or Google Chrome browser and used to explore and audit the content of any webpage. The goal is to make the On-Page Technical SEO Analysis an effective and easy tool for everybody, and in particular for non technical people.

Performing a On-Page Technical SEO Analysis requires analyzing several (almost) hidden elements of an HTML page, including Meta Tags, Structured Data, JavaScrips, Robots.txt and Sitemap.xml files. It can be a challenging task, in particular for people without a strong technical background. Many of these elements are important for the page SEO performance. Page Auditor makes it easy to check all these elements. It can be used to analyze our own web pages, as well as our competitors' pages.

Page Auditor automatically scans the HTML code of the selected page to locate specific HTML elements, like <script> and <meta> tag elements. Then it extracts the relevant content and attributes of each tag and classifies them according to manually-curated internal lists of categories. The result of the analysis is then presented to the user in clear, well formatted, human readable reports. Compared to a manual analysis of the same page, the benefits are evident. For example, the JSON-LD and the JavaScript code included in a page provide critical information about the page, but they are frequently compressed and almost unreadable for humans. In fact they are intended to provide information to the browser and to the search engin crawlers visiting the page.Page Auditor takes care of making this information accessible by properly formatting the code and the content of these items and providing detailed information about the meaning and use of each one ofg them.

Features

Structured Data Report
Screenshot 1 640x400 pixels
JavaScript Code Report (Tracking, Analytics, Ads)
Screenshot 2 640x400 pixels
Meta Tags Report
Screenshot 3 640x400 pixels
Robots.txt & Sitemap.xml Report
Screenshot 4 640x400 pixels
HTML Report
Screenshot 5 640x400 pixels
To-Do Report
Screenshot 5 640x400 pixels

License

This Google Chrome Extension is open source and it is released under BSD-3-Clause license.

Running the Live Version

Testing the live version of Page Auditor, the version publicly available on the Microsoft Edge Add-ons Store and on the Google Chrome Web Store, is very simple. Visit the Page Auditor for Edge page on Edge Add-ons or the Page Auditor for Chrome page on Google Chrome Store and follow the instructions to start the installation. Once you installed the extension, visit a web page you would like to analyze and start the extension from the Extensions Menu on the top right corner of your browser.

Page Auditor on Microsoft Edge Add-ons Store and Google Chrome Web Store
"Page Auditor" on Google Chrome Web Store

Testing a New Version on Chrome

This is how to test the Extension or any variation opf it on your Google Chrome Web Store (the process for Microsoft Edge is similar):

  1. Make sure the file package.json define the build target as "Chrome". Line of the file should be: "target": "Chrome", if you are building for Chrome, and "target": "Edge", if you are building for Edge.
  2. Generate a new build with the command npm run build
  3. Open the Google Chrome Extensions page on your browser by entering the following URL: chrome://extensions/
  4. Select the [Load Unpacked] button on the top left corner of the page.
  5. When the [Select Folder] panel opens, navigate your computer file system and select the /dist folder of the extension.
  6. Now you can run your local copy of the extension by clicking on the extension icon on the top right corner of your Google Chrome browser. If you don't see the Extensions logo on the browser corner, select the extensions icon and pin the PageAuditor extension to the main toolbar.
  7. To test new changes (fresh files are in the ./dist folder) click the refresh icon on the Extension box in the same chrome://extensions/ page.

Testing the Code

There is a battery of tests implemented with jest. At the moment, September 2021, the tests are covering 100% of Statements and Functions.

File % Stmts % Branch % Funcs % Lines Uncovered Line #s
All files 100 96.02 100 100
src 100 100 100 100
- card.ts 100 100 100 100
src/sections 100 95.98 100 100
- credits.ts 100 100 100 100
- intro.ts 100 100 100 100
- ld-json-functions.ts 100 84.21 100 100 33-60
- ld-json.ts 100 100 100 100
- meta-functions.ts 100 98.1 100 100 61,93
- meta.ts 100 94.74 100 100 28-33
- robots-functions.ts 100 100 100 100
- robots.ts 100 100 100 100

Run npm run test-coverage to generate the tests coverage report. The report will be available at coverage/lcov-report/index.html

Formatting the Code

To format the code with Prettier run npm run format.

Additional Information

  • This extension is based on a Google Chrome Snippet I described in an article I published on Medium on May 14, 2021. The article's title is Exploring Structured Data With A Google Chrome Snippet. Since the initial idea and implementation the extension has been growing significantly including more analysis and brand new reports.

  • On September 16, 2021 I published an article on Medium for a non-technical audience describing the features and the usage of the Page Auditor Chrome Extension. The article's title is I wrote a Chrome Extension to perform on-page SEO analysis.

All information and creative required to publish the Google Chrome eExtension are available on the folder Google Web Store creative material.

Roadmap

  • Porting the snippet from JavaScript to TypeScript
  • Transform the Google Chrome Snippet into a regular Google Chrome Extension
  • Porting the Extension to the Microsoft Edge browser / platform
  • Highlighting of images missing the alt attribute or failing download
  • Reorganize the user interface with a summary and links to each section. No more tabs.
  • Add more SEO features, like

Copyright (c) 2021, Franco Folini All rights reserved.

page-auditor's People

Contributors

folini avatar passariello avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar

page-auditor's Issues

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.