README.md

Welcome to the Platforce documentation

Platforce Documentation for Developers in NAV on the Salesforce Platform

Local development

Prerequisites

Please note the following requirements to be able to run below steps for local development.

• Python 3.11 or later - Download Python.

on macOS

• Homebrew

on Windows

• Scoop

1. Install pipx

On macOS

brew install pipx
pipx ensurepath

On Linux

sudo apt update
sudo apt install pipx
pipx ensurepath

On Windows

scoop install pipx
pipx ensurepath

2. Install Make

On Windows

scoop install make

3. Install Poetry

pipx install poetry

4. Install dependencies

make install

5. Serve the documentation locally

make local

6. All

One command to do step 4 and 5; Install dependencies and serve the documentation locally.

make all

Utility commands

The following commando will copy the project README.md file to the docs folder as project-readme.me to include it in the documentation.

This is also rune as part of the make local command.

make copyreadme

Useful links and resources

Here you will fins a list of useful links and resources that are used to create this documentation project.

Documentation tools

• MkDocs
• Material for MkDocs
• PyMdown Extensions
• Pygments
• mkdocs-git-revision-date-localized-plugin
• MkDocs Awesome Pages Plugin

Project and Build tools

• GNU Make (Makefile)
• Makefile Tutorial
• Python
• Poetry
• pipx