HGKeeper

Remove mermaid.js from footer and theme.

2020-08-20, Elliott Sales de Andrade

136c099f1388

Remove mermaid.js from footer and theme.

It is not used anywhere, and maybe should only be loaded if we actually do any mermaid diagrams.

This cuts down front page no-cache load from 1.71 MB to 914.43 kB.

Testing Done:
Loaded the front page. Also, searched for use of the mermaid shortcode, which was non-existent.

Reviewed at https://reviews.imfreedom.org/r/75/

# Pidgin Nest

The place we like call home.

This repository contains the source for the next generation site for pidgin.im.

## Dependencies

This project uses [hugo](https://gohugo.io/), get it

[here](https://gohugo.io/getting-started/installing/)

## Developing Docs

To start development server run:

`hugo server -s hugo -D --disableFastRender -v --verboseLog --noHTTPCache --i18n-warnings`

- `--disableFastRender` Disabling fast render is needed because hugo starts to

ignore new content in the data dir

- `-v --verboseLog` Better logging and debugging experience

- `--noHTTPCache` To prevent caching issues

## Docker

1. `docker build -t pidgin/nest:latest .`

2. `docker run -it --rm -p 3000:3000 pidgin/nest:latest`

## Formatting

These are some regex's to quickly format templating

| regex | replace |

| -------------------- | -------- |

| `\{\{(\w|\.|\$|\()` | `{{ $1` |

| `\{\{-(\w|\.|$)` | `{{- $1` |

| `("|\w|\.|\))(-)?}}` | `$1 }}` |

## Hugo config

To disable **Copy Code to Clipboard** the `disableInlineCopyToClipBoard` switch

can be used either in **config** `[params]` **or** in the front matter of the

individual page

## Tools

- **Visual Regression**

1. [Run dev server](#Developing-Docs)

1. To run the visual diff tool call `node tools/visual-diff.js` or

`npm run regression`

## Alert Notification

![](docs/images/notifications.png)

Notifications are configured in `hugo/config.toml`

```toml

[params]

notificationMessage = "Great News Everyone!"

notificationCode = "nest-launch"

```

- `notificationMessage` is the message and is fully HTML

- `notificationCode` is used as the key to remember if the notification has been cleared

If Either of these are unset, the template will not render

The notification template is rendered `display: none` in the

`hugo/layouts/partials/custom-footer.html`, and then hoisted to the top of the

page if the cookie is not equal to the code.