{"id":20635772,"url":"https://github.com/psu-libraries/tei-render","last_synced_at":"2025-09-26T18:31:23.604Z","repository":{"id":41722147,"uuid":"238496827","full_name":"psu-libraries/tei-render","owner":"psu-libraries","description":"A web component for rendering TEI encoded XML documents to HTML in the browser.","archived":false,"fork":false,"pushed_at":"2023-06-03T03:59:58.000Z","size":7382,"stargazers_count":2,"open_issues_count":22,"forks_count":2,"subscribers_count":7,"default_branch":"master","last_synced_at":"2024-11-16T15:07:07.501Z","etag":null,"topics":["appint-team"],"latest_commit_sha":null,"homepage":"","language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/psu-libraries.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2020-02-05T16:31:17.000Z","updated_at":"2022-07-29T19:22:13.000Z","dependencies_parsed_at":"2023-02-03T15:46:19.772Z","dependency_job_id":null,"html_url":"https://github.com/psu-libraries/tei-render","commit_stats":null,"previous_names":[],"tags_count":1,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/psu-libraries%2Ftei-render","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/psu-libraries%2Ftei-render/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/psu-libraries%2Ftei-render/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/psu-libraries%2Ftei-render/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/psu-libraries","download_url":"https://codeload.github.com/psu-libraries/tei-render/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":234331294,"owners_count":18815360,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["appint-team"],"created_at":"2024-11-16T15:07:23.566Z","updated_at":"2025-09-26T18:31:18.172Z","avatar_url":"https://github.com/psu-libraries.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# \\\u003ctei-render\u003e\n\nThis webcomponent follows the [open-wc](https://github.com/open-wc/open-wc) recommendation.\n\n## Installation\n```bash\nnpm i tei-render\n```\n\n## Usage\n```html\n\u003cscript type=\"module\"\u003e\n  import 'tei-render/tei-render.js';\n\u003c/script\u003e\n\n\u003ctei-render\u003e\u003c/tei-render\u003e\n```\n\n## Linting with ESLint, Prettier, and Types\nTo scan the project for linting errors, run\n```bash\nnpm run lint\n```\n\nYou can lint with ESLint and Prettier individually as well\n```bash\nnpm run lint:eslint\n```\n```bash\nnpm run lint:prettier\n```\n\nTo automatically fix many linting errors, run\n```bash\nnpm run format\n```\n\nYou can format using ESLint and Prettier individually as well\n```bash\nnpm run format:eslint\n```\n```bash\nnpm run format:prettier\n```\n\n## Testing with Karma\nTo run the suite of karma tests, run\n```bash\nnpm run test\n```\nor to run them in compatibility mode for legacy browsers\n```bash\nnpm run test:compatibility\n```\n\nTo run the tests in watch mode (for \u003cabbr title=\"test driven development\"\u003eTDD\u003c/abbr\u003e, for example), run\n\n```bash\nnpm run test:watch\n```\nor\n```bash\nnpm run test:compatibility\n```\n\n## Testing with Karma via BrowserStack\nTo run the suite of karma tests in BrowserStack, run\n```bash\nnpm run test:bs\n```\n\n## Managing Test Snapshots\nYou can manage the test snapshots using\n```bash\nnpm run test:update-snapshots\n```\nor\n```bash\nnpm run test:prune-snapshots\n```\n\n## Demoing with Storybook\nTo run a local instance of Storybook for your component, run\n```bash\nnpm run storybook\n```\n\nTo build a production version of Storybook, run\n```bash\nnpm run storybook:build\n```\n\n\n## Local Demo with `es-dev-server`\n```bash\nnpm start\n```\nTo run a local development server that serves the basic demo located in `demo/index.html`\n\n```bash\nnpm start:compatibility\n```\nTo run a local development server in compatibility mode for older browsers that serves the basic demo located in `demo/index.html`\n# tei-render\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fpsu-libraries%2Ftei-render","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fpsu-libraries%2Ftei-render","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fpsu-libraries%2Ftei-render/lists"}