Skip to content
This repository was archived by the owner on Feb 20, 2022. It is now read-only.

techouse/laravel-nova-docs-parser

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

5 Commits
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Laravel Nova docs parser

Requirements:

  • Python 3.4+
  • Node.js
  • Git

Installation and usage

python3 -m venv env
source env/bin/activate
pip install -r requirements.txt
sh get_docs.sh
python parser.py

The above commands will make a virtual environment in a folder called env and install all the requirements listed in requirements.txt into that virtual environment. Once that is done running sh get_docs.sh will clone the git repository of laravel/nova-docs and build the Laravel Nova HTML documentation using vuejs/vuepress. Then running python parser.py will parse that documentation. It will output a file called data.json which you can later use to your avail.

The output JSON file looks like this:

[
  {
    "version": 2.0,
    "id": "trix-field",
    "title": "Trix Field",
    "permalink": "https://nova.laravel.com/docs/2.0/resources/fields.html#trix-field",
    "categories": [
        "Fields"
    ],
    "content": "The Trix field provides a Trix editor for its associated field. Typically, this field will correspond to a TEXT column in your database. The Trix field will store its corresponding HTML within the associated database column:"
  }
]

About

Laravel Nova docs parser

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published