diff --git a/src/Umbraco.Web.UI.Docs/.nvmrc b/src/Umbraco.Web.UI.Docs/.nvmrc new file mode 100644 index 0000000000..ec3053c8dc --- /dev/null +++ b/src/Umbraco.Web.UI.Docs/.nvmrc @@ -0,0 +1 @@ +10.15 diff --git a/src/Umbraco.Web.UI.Docs/README.md b/src/Umbraco.Web.UI.Docs/README.md index c6f3893e55..6a42c38915 100644 --- a/src/Umbraco.Web.UI.Docs/README.md +++ b/src/Umbraco.Web.UI.Docs/README.md @@ -1,14 +1,16 @@ # 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: ``` npm ci -npx gulp docs +npm start ``` After this, you should have an `api` directory which contains index.html. -In order to check if the documentation works properly, you would need to run the `api` directory in a webserver. On Windows, this can be accomplished by opening the `api` directory in [Visual Studio Code](https://code.visualstudio.com/) and running it with the [IIS Express plugin](https://marketplace.visualstudio.com/items?itemName=warren-buckley.iis-express). \ No newline at end of file +In order to check if the documentation works properly, you would need to run the `api` directory in a webserver. On Windows, this can be accomplished by opening the `api` directory in [Visual Studio Code](https://code.visualstudio.com/) and running it with the [IIS Express plugin](https://marketplace.visualstudio.com/items?itemName=warren-buckley.iis-express). diff --git a/src/Umbraco.Web.UI.Docs/gulpfile.js b/src/Umbraco.Web.UI.Docs/gulpfile.js index e595eabe5d..53f7f2cf8d 100644 --- a/src/Umbraco.Web.UI.Docs/gulpfile.js +++ b/src/Umbraco.Web.UI.Docs/gulpfile.js @@ -18,7 +18,7 @@ gulp.task('docs', [], function (cb) { var options = { html5Mode: false, startPage: '/api', - title: "Umbraco 12 Backoffice UI API Documentation", + title: "Umbraco 13 Backoffice UI API Documentation", dest: './api', styles: ['./umb-docs.css'], image: "https://our.umbraco.com/assets/images/logo.svg"