yv01p/Umbraco-CMS
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

update apidocs ui section to Umbraco 13

Browse Source
This commit is contained in:
Jacob Overgaard
2024-01-24 16:29:00 +01:00
parent 0821fb64bb
commit 802e5a8c27
3 changed files with 7 additions and 4 deletions
Download Patch File Download Diff File Expand all files Collapse all files

1
src/Umbraco.Web.UI.Docs/.nvmrc Normal file
View File

@@ -0,0 +1 @@
10.15

6
src/Umbraco.Web.UI.Docs/README.md
View File

@@ -1,12 +1,14 @@
# Umbraco Backoffice UI API Documentation # Umbraco Backoffice UI API Documentation
This project builds the documentation for the UI of the Umbraco backoffice, it is published on Our Umbraco in the "Reference" section of the documentation. This project builds the documentation for the UI of the Umbraco backoffice, it is published on the Umbraco Docs in the "Reference" section of the documentation.
All versions can be accessed through the https://apidocs.umbraco.com/vXX/ui/ url where XX is the major version number of Umbraco.
In order to build the documentation, please follow the following two steps: In order to build the documentation, please follow the following two steps:
``` ```
npm ci npm ci
npx gulp docs npm start
``` ```
After this, you should have an `api` directory which contains index.html. After this, you should have an `api` directory which contains index.html.

2
src/Umbraco.Web.UI.Docs/gulpfile.js
View File

@@ -18,7 +18,7 @@ gulp.task('docs', [], function (cb) {
var options = { var options = {
html5Mode: false, html5Mode: false,
startPage: '/api', startPage: '/api',
title: "Umbraco 12 Backoffice UI API Documentation", title: "Umbraco 13 Backoffice UI API Documentation",
dest: './api', dest: './api',
styles: ['./umb-docs.css'], styles: ['./umb-docs.css'],
image: "https://our.umbraco.com/assets/images/logo.svg" image: "https://our.umbraco.com/assets/images/logo.svg"