Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[BUG] At sign replaced by a brace in markdown code blocks #189

Closed
victorlevasseur opened this issue May 29, 2017 · 1 comment
Closed

[BUG] At sign replaced by a brace in markdown code blocks #189

victorlevasseur opened this issue May 29, 2017 · 1 comment

Comments

@victorlevasseur
Copy link

Overview of the issue

When generating an additionnal documentation page (in markdown), all the '@' signs are replaced by '(' when they are in code blocks.

Operating System, Node.js, npm, compodoc version(s)

Linux, Node 6.10.3, npm 3.10.10, compodoc 1.0.0-beta.9, Angular 4.1.3

Angular configuration, a package.json file in the root folder

Here is my package.json (it uses Angular CLI):

{
  ...
  "scripts": {
    "ng": "ng",
    "start": "ng serve",
    "build": "ng build",
    "test": "ng test",
    "lint": "ng lint",
    "e2e": "ng e2e",
    "docs": "node_modules/.bin/compodoc -p tsconfig.json -d docs --includes src/doc",
    "serve-docs": "node_modules/.bin/compodoc -s -d docs --includes src/doc",
    "i18n-extract": "node node_modules/@biesbjerg/ngx-translate-extract --input ./src --output ./src/assets/i18n/*.json --clean --sort --format namespaced-json"
  },
  "private": true,
  "dependencies": {
    "@angular/animations": "~4.1.0",
    "@angular/common": "~4.1.0",
    "@angular/compiler": "~4.1.0",
    "@angular/core": "~4.1.0",
    "@angular/forms": "~4.1.0",
    "@angular/http": "~4.1.0",
    "@angular/platform-browser": "~4.1.0",
    "@angular/platform-browser-dynamic": "~4.1.0",
    "@angular/router": "~4.1.0",
    "@ngx-translate/core": "^6.0.1",
    "@ngx-translate/http-loader": "0.0.3",
    "@swimlane/ngx-datatable": "^9.1.0",
    "angular2-materialize": "^15.0.1",
    "core-js": "^2.4.1",
    "materialize-css": "^0.98.2",
    "ng2-responsive": "^0.8.4",
    "ngx-toastr": "^5.2.1",
    "rxjs": "^5.1.0",
    "scriptjs": "^2.5.8",
    "web-animations-js": "^2.2.5",
    "zone.js": "^0.8.4"
  },
  "devDependencies": {
    "@angular/cli": "1.0.1",
    "@angular/compiler-cli": "~4.1.0",
    "@biesbjerg/ngx-translate-extract": "^2.3.1",
    "@compodoc/compodoc": "1.0.0-beta.9",
    "@types/jasmine": "2.5.38",
    "@types/materialize-css": "^0.98.0",
    "@types/node": "~6.0.60",
    "@types/scriptjs": "0.0.2",
    "codelyzer": "~2.0.0",
    "jasmine-core": "~2.5.2",
    "jasmine-spec-reporter": "~3.2.0",
    "karma": "~1.4.1",
    "karma-chrome-launcher": "~2.0.0",
    "karma-cli": "~1.0.1",
    "karma-coverage-istanbul-reporter": "^0.2.0",
    "karma-jasmine": "~1.1.0",
    "karma-jasmine-html-reporter": "^0.2.2",
    "protractor": "~5.1.0",
    "ts-node": "~2.0.0",
    "tslint": "~4.5.0",
    "typescript": "~2.2.0"
  }
}

Compodoc installed globally or locally ?

Compodoc is installed locally

Reproduce the error

Just create a additionnal doc page where you put an 'at sign' in a code block. For instance, instead of:

@import 'aaa'

you will get:

(import 'aaa'
@victorlevasseur victorlevasseur changed the title [BUG] At sign replaced by a brace in code blocks [BUG] At sign replaced by a brace in markdown code blocks May 29, 2017
@lock
Copy link

lock bot commented Oct 1, 2019

This issue has been automatically locked due to inactivity. Please file a new issue if you are encountering a similar or related problem. Why locking ? Having issues with the most up-to-date context.

@lock lock bot locked as resolved and limited conversation to collaborators Oct 1, 2019
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Projects
None yet
Development

No branches or pull requests

2 participants