Giter Club home page Giter Club logo

uxp-indesign's Introduction

Adobe I/O Documentation Template

This is a site template built with the Adobe I/O Theme.

View the demo running on Github Pages.

Where to ask for help

The slack channel #adobeio-onsite-onboarding is our main point of contact for help. Feel free to join the channel and ask any questions.

How to develop

For local development, simply use :

$ yarn install
$ yarn dev

(also use yarn clean)

For the documentation developer, please read these sections on how to:

For more in-depth instructions.

How to test

  • To run the configured linters locally (requires Docker):

    yarn lint

    NOTE If you cannot use Docker, you can install the linters separately. In .github/super-linter.env, see which linters are enabled, and find the tools being used for linting in Supported Linters.

  • To check internal links locally

    yarn test:links
  • To build and preview locally:

    yarn start

How to deploy

For any team that wishes to deploy to the adobe.io and stage.adobe.io website, they must be in contact with the dev-site team. Teams will be given a path that will follow the pattern adobe.io/{product}/. This will allow doc developers to setup their subpaths to look something like:

adobe.io/{product}/docs
adobe.io/{product}/community
adobe.io/{product}/community/code_of_conduct
adobe.io/{product}/community/contribute

Launching a deploy

You can deploy using the GitHub actions deploy workflow see deploy instructions.

Redirections

  • https://developer.adobe.com/indesign/uxp/guides/ -> https://developer.adobe.com/indesign/uxp/
  • https://developer.adobe.com/indesign/uxp/server/ -> https://developer.adobe.com/indesign/uxp/
  • https://developer.adobe.com/indesign/uxp/recipes/ -> https://developer.adobe.com/indesign/uxp/
  • https://developer.adobe.com/indesign/uxp/uxp-scripting-samples/ -> https://developer.adobe.com/indesign/uxp/

URLs

During InDesign v18.5 release, we revamped the information architecture of the whole site. This will break previously (prior to v18.5) bookmarked URLs.

Search metadata

Contribute

Recipes

Use the template for recipes and make sure you provide all the necessary details. Open a pull request.

uxp-indesign's People

Contributors

erinfinnegan avatar timkim avatar padmkris123 avatar pklaschka avatar anoopvalomkot avatar dependabot[bot] avatar akshayvc1 avatar oihamza avatar sujaisivanandan avatar bdenham avatar dmitrymatio avatar vkumarg avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.