plex Documentation

Technical Documentation: IBM/plex

ℹ️ Provenance: Multi-Tier Ingestion · CodeWiki Reference

Overview (README.md) Copy Section

IBM Plex® typeface

Meet the IBM Plex® typeface, our corporate typeface family. It’s global, it’s versatile and it’s distinctly IBM.

We designed the IBM Plex typeface carefully to meet our needs as a global tech company and express who we are as IBMers. It took two years and a lot of work to get here, but today, we have a signature typeface we’re proud of and excited to share with the world. Discover more about our development of the IBM Plex typeface.

The IBM Plex typeface is an open-source project available for download and various uses following the Open Font License (OFL). The IBM Plex family comes in Sans, Serif, Mono, and Sans Condensed, all with Roman and true italics. Plex has been designed to work well in user interface (UI) environments and other mediums. This project provides all source files and multiple formats to support most typographical situations. Currently, IBM Plex Sans supports extended Latin, Arabic, Chinese (Traditional), Cyrillic, Devanagari, Greek, Hebrew, Japanese, Korean, and Thai.

Additionally, we have introduced IBM Plex® Math. This highly anticipated release includes over 5,000 new glyphs, covering a wide range of mathematical symbols such as alphanumeric, double-struck, Fraktur, operators, script, icons, arrows, Greek letters, phonetics, technical and geometric shapes — making it one of the most complete math fonts available today. IBM Plex Math provides a fresh and comprehensive alternative to STIX and Microsoft’s Cambria. Its compatibility with IBM Plex Serif Regular makes it an ideal choice for IBM researchers and mathematicians.

Thanks for trying the IBM Plex typeface! We hope you like it.

Add the IBM Plex typeface to your device Copy Chapter

Please download the latest zip files from our releases page for installation.

IBM Plex typeface packages Copy Section

Release (`docs/release.md`) Copy Section

Release

To release a new version of plex, the following steps can be taken:

Setup Copy Chapter

1. Clone and open the plex repo folder in finder
2. Create a new release branch with the version to be released release/v6.x.x
3. Ensure you're using the correct version of node by running nvm use
4. Run yarn to install
5. Run yarn build to build

Gather new files Copy Chapter

1. Download the new/updated source files from box and open in a second finder window
2. Unzip the new source files
   1. Observe the file structure. The structure within box does not always map 1:1 to the structure of the repository.

Copy/replace files Copy Chapter

1. Open two finder windows and drag and drop or copy and paste the new versions into the repo folder structure.
2. When presented with the prompt to skip, stop, or replace - choose "Replace" and check "Apply to All"
3. Repeat the previous steps one by one for each family - sans, serif, mono, etc.
4. Double check the changeset with git status. Make sure there are no unintended changes.
5. Ensure families are separate and contain only the intended files. IBMPlexSans-* source files should only be within the IBM-Plex-Sans folder, for instance.
   1. If in doubt, or you see unexpected file changes, reach out to Bold Monday.

Test Copy Chapter

1. Run yarn test
2. Use the firefox dev tools to inspect and ensure the proper font families are being used on the test site.
3. Do any additional testing required to validate the changes

Create release PR Copy Chapter

1. Commit and push changes
2. Make a PR titled "Release v6.x.x"

Release Copy Chapter

Once the PR has been approved and merged, you can follow these steps to release:

1. Switch branch to master, pull down latest git pull
2. Run git log the most recent commit should be the commit for your changes just merged in.
3. Run prepare to clean and build files
4. Run yarn build:zip to build zip files
5. Run npm version <version>
   1. Replace <version> with the intended semver bump depending on the type of release you want to publish(major, minor, patch). In most cases the release will be npm version minor or npm version patch.
6. Run npm publish
   1. This can take a while as it's uploading the large amount of source files.
7. Once finished, make sure the release is present at https://www.npmjs.com/package/@ibm/plex
8. Run git push --tags
9. Make a new release on GitHub for the new tag that was created for the release.
10. Copy over changelog from the box folder
    1. This file contains the entire changelog since the initial release, so remove everything except the most recent change(s) included in this release.
11. Check the box to open a discussion for this release
12. In Finder, within the /zip directory, select all the .zip files. Drag them from Finder to the GitHub release page to upload the assets to the release. These files are large and the upload will take some time.
13. Save/publish the GitHub release

Close related issues Copy Chapter

Oftentimes the changelog will contain a link to an issue as reference for a particular change. Each issue needs a comment posted.

Open all related issues in different tabs, then for each tab repeat this process:

1. Scroll to the bottom and post the following comment
   1. Replace v6.x.x with the current release in both the link text and the url.
   2. Replace the ### in the release discussion url with the discussion issue number

Hey there! [v6.x.x](https://github.com/IBM/plex/releases/tag/v6.x.x) was just released that references this issue.

Comment here or join the [release discussion](https://github.com/IBM/plex/discussions/###) to provide feedback or voice concerns. Thanks!

2. Close the issue if it's not already closed. If the issue is not complete, it can be reopened.

--- METRICS ---

• Files Extracted: 2
• Estimated Token Budget: ~1936 tokens
• Canonical Reference: https://codewiki.google/github.com/IBM/plex