Guide to Install and Config Laravel-doc

Welcome ! 🎉

This documentation intend to simplify and automate PHPDoc generation after any migrate command with Laravel Model PHPDoc Generator.

You can checkout the initial documentation of the library by hitting the link Laravel Model PHPDoc Generator Github

Project Installation

• Create your laravel with this command.

  laravel new yourProjectName

• Run this command to install the package needed to generate annotations PhpDoc

  composer require romanzipp/laravel-model-doc --dev

Configuration

• Run this command on the terminal and go check if there is a new file in config folder like config/model-doc.php.

php artisan vendor:publish --provider="romanzipp\ModelDoc\Providers\ModelDocServiceProvider"

• Copy this code snippet and paste it into AppServiceprovider file.

  public function boot(): void
{
    $this->initDoc();
}

public function initDoc(){
    setlocale(LC_TIME, 'fr_FR');
    Carbon::setLocale('fr');
    DB::connection()->getEventDispatcher()->listen(
        \Illuminate\Database\Events\MigrationsEnded::class,
        function () {
            if (!app()->isProduction()) {
                Artisan::call('model-doc:generate');
            }
        }
    );
}

php artisan vendor:publish --provider="romanzipp\ModelDoc\Providers\ModelDocServiceProvider"

  print('Hello, world!')

:::success

💡 Are you in Both Mode?

Before we get into the details, make sure you are in Both Mode. Please locate these three icons at the top of HackMD, with which you can toggle Edit/Both/View mode (from left to right).

Let's set it to Both Mode, so that you can take notes in Markdown in the left pane and see how it renders in the right pane.

:::

You can try things out right in this note as a playground or leave it in your workspace as a cheatsheet.

:::success

💡 Are you in Both Mode?

Before we get into the details, make sure you are in Both Mode. Please locate these three icons at the top of HackMD, with which you can toggle Edit/Both/View mode (from left to right).

Let's set it to Both Mode, so that you can take notes in Markdown in the left pane and see how it renders in the right pane.

:::

Writing in Markdown is easy. It's just using plaintext to format your text. Here are some Markdown elements that you may find useful. Add them to your writings to give them nice and helpful structures.

Frequently used elementsmgf

  print('Hello, world!')
  # See if you can set arbitrary line number or 
  # change syntax highlighting for different language
  # in this code block.

• unordered list

1. ordered list

• task

quote

Link

Styles of text

bold

italics

literals

strikethrough

==highlight==

21^th^ Centuary

H2O

Image


Just drag and drop an image anywhere in the editor, HackMD will render it for you.

You can change the size of the above image. See how →.

Headers

Put # at the beginning of a line, it becomes a header. Three #s creates a level 3 header, like this:

A Level 3 Header

Paragraph

As intuitive as it is, it's worth mentioning that leaving an empty line (by pressing Enter or Return ) lets you separate paragraphes.

Table

Column 1	Column 2	Column 3
Some	thing	nice
Text	Text	Text

Drawing tables with Markdown can be messy, so we created a tool to boost your productivity. Click on any cell in the table above and note the table tool appears in the toolbar on top of the editor changes.

Learn more about table tool here →

Extensions

Although the following extensions are not included in regular Markdown, they are widely accepted as useful elements of documentations.

Humans can read them rather easily, so feel free to use them in your notes.

Write formulas with MathJax

$$ e^{ \pm i\theta } = \cos \theta \pm i\sin \theta $$

Draw UML diagrams to aid communication

graph LR

Work --> flow -- like --> this

Loading

HackMD supports many other UML diagrams. Read more →

Table of Content

You can type [toc] to add a table of content of your note as below:

[toc]

:::info :bulb: Navigating Menu

You can bring up the table of contents by clicking the ☰ icon at the bottom-left of the View pane:

:::

Admonitions

Use these text boxes to emphasize important ideas. Can you change those emojis?

:::warning :warning: Warnings :::

:::danger :radioactive_sign: Danger :::

:::info :information_source: Info :::

:::success :thumbsup: Success :::

:::success :thumbsdown: Success :::

Why Markdown?

Markdown describes the structure of the content explicitly with plain text, almost like writing in 'code', while keeping it human readable. This has two major advantages:

1. You can focus on the content as you write and leave styling and structures for later.
2. Writing in plaintext means your content is portable to any platform (device, operating system, or app). It may look somewhat different in each rendering, yet the content is all the same and no vendor lock-in.

Further Questions

In our tutorial book, you will find detailed guides to all main features of HackMD that boost your productivity. You will even learn how to publish a book! 💯

Feel free to ping us for questions:

• 📫 [email protected]

• Mention @hackmdio on Twitter

• fef ejfe