Skip to content

Commit

Permalink
docs(README): fix deploy button images (#127)
Browse files Browse the repository at this point in the history
  • Loading branch information
dschach authored Feb 9, 2024
1 parent f6c068c commit d3717fc
Show file tree
Hide file tree
Showing 8 changed files with 47 additions and 42 deletions.
2 changes: 2 additions & 0 deletions apexdox.yml
Original file line number Diff line number Diff line change
Expand Up @@ -30,6 +30,8 @@ engine:
- '${workspaceFolder}/doc-assets/index.css'
- '${workspaceFolder}/doc-assets/highlight.js'
- '${workspaceFolder}/doc-assets/index.js'
- '${workspaceFolder}/media/deploy-package-to-prod.png'
- '${workspaceFolder}/media/deploy-package-to-sandbox.png'

port: 8080
docblock:
Expand Down
39 changes: 20 additions & 19 deletions doc-assets/highlight.js
Original file line number Diff line number Diff line change
Expand Up @@ -1211,27 +1211,27 @@ aliases:["yml"],contains:l}}});const He=ae;for(const e of Object.keys(Ke)){
const n=e.replace("grmr_","").replace("_","-");He.registerLanguage(n,Ke[e])}
return He}()
;"object"==typeof exports&&"undefined"!=typeof module&&(module.exports=hljs);

/*! `apex` grammar compiled for Highlight.js 11.9.0 */
(()=>{var e=(()=>{"use strict";return e=>{
const t=e.regex,a="[a-zA-Z][a-zA-Z_0-9]*",c="\\b"+a+"\\b",n="@"+a,o=/(?=\s*\()/,s=/\s+/,r=/\?\./,i=[{
match:/(?<!\?)\./,scope:"punctuation",relevance:0},{match:r,scope:"operator",
const t=e.regex,a="[a-zA-Z][a-zA-Z_0-9]*",c="\\b"+a+"\\b",n="@"+a,o=/(?=\s*\()/,s=/\s+/,i=/\?\./,r=[{
match:/(?<!\?)\./,scope:"punctuation",relevance:0},{match:i,scope:"operator",
relevance:0}];function l(...e){return t.concat("(?!",e.join("|"),")")}const p={
scope:"number",
match:t.either(/\b(\d{4}\-\d{2}\-\d{2}T\d{2}\:\d{2}\:\d{2}(\.\d{1,3})?(\-|\+)\d{2}\:\d{2})\b/,/\b(\d{4}\-\d{2}\-\d{2}T\d{2}\:\d{2}\:\d{2}(\.\d{1,3})?(Z)?)\b/,/\b(\d{4}\-\d{2}\-\d{2})\b/,/\b0(x|X)[0-9a-fA-F_]+(U|u|L|l|UL|Ul|uL|ul|LU|Lu|lU|lu)?\b/,/\b0(b|B)[01_]+(U|u|L|l|UL|Ul|uL|ul|LU|Lu|lU|lu)?\b/,/\b([0-9]+)?\.[0-9]+((e|E)[0-9]+)?(F|f|D|d|M|m)?\b/,/(-?)\b[0-9]+(e|E)[0-9]+(F|f|D|d|M|m)?\b/,/(-?)\b[0-9]+(F|f|D|d|M|m)\b/,/(-?)\b[0-9]+(U|u|L|l|UL|Ul|uL|ul|LU|Lu|lU|lu)?\b/,/(-?)(\b0[0-9]+|(\b\d+(\.\d*)?|\.\d+)([eE][-+]?\d+)?)/),
relevance:0
},b=["try","catch","finally","get","set","put","if","for","else","do","while","continue","break","implements","extends","return","throw","when","new"],u=["instanceof","super","this"],d=["abstract","final","global","override","private","protected","public","static","testMethod","transient","virtual","webservice"],m=["anytype|0","blob|0","boolean|0","byte|0","currency|0","date|0","datetime|0","decimal|0","double|0","enum|0","float|0","integer|0","long|0","object|0","pagereference|8","selectoption|8","short|0","sobject|10","string|0","time|0","void|0","float|0"],E=["insert","update","upsert","delete","undelete","merge","convertLead"],A=["AppLauncher","Approval","Auth","Cache","Canvas","ChatterAnswers","CommercePayments","ConnectApi","Database","Datacloud","Dataweave","DataSource","Dom","EventBus","ExternalService","Flow","Functions","Invocable","KbManagement","LxScheduler","Messaging","Metadata","Pref_center","Process","QuickAction","Reports","RichMessageing","Schema","Search","Sfc","Sfdc_Checkout","sfdc_surveys","Site","Support","System","TerritoryMgmt","TxnSecurity","UserProvisioning","VisualEditor","Wave"],h=["AccessLevel","Address","Answers","ApexPages","Approval","Assert","AsyncInfo","AsyncOptions","BusinessHours","Cases","Collator","Continuation","Cookie","Crypto","Database","Date","Datetime","Decimal","Domain","DomainCreator","DomainParser","EmailMessages","EncodingUtil","EventBus","Exception","FeatureManagement","FlexQueue","Formula","FormulaRecalcFieldError","FormulaRecalcResult","Http","HttpRequest","HttpResponse","Ideas","JSON","JSONGenerator","JSONParser","Label","Limits","Location","Matcher","Math","Messaging","MultiStaticResourceCalloutMock","Network","OrgLimit","OrgLimits","Packaging","PageReference","Pattern","QueueableDuplicateSignature","QueueableDuplicateSignature.Builder","QuickAction","Request","ResetPasswordResult","RestContext","RestRequest","RestResponse","Search","Security","SelectOption","Site","SObject","SObjectAccessDecision","StaticResourceCalloutMock","Test","TimeZone","Type","URL","UserInfo","UserManagement","Version","WebServiceCallout","XmlStreamReader","XmlStreamWriter"],v=["AccessType","AccessLevel","DomainType","JSONToken","LoggingLevel","Quiddity","TriggerOperation","operationType"],S=["false","true","null"],g={
match:/,/,scope:"punctuation",relevance:0
},R=[/--/,/\+\+/,/\&\&|\|\|/,/\*\=|\/\=|\%\=|\+\=|-\=/,/\&\=|\^\=|<<\=|>>\=|>>>\=|\|\=/,/\&|~|\^|\|/,/<<|>>/,/<\=|>\=|\s(<|>)\s/,/\=\=|!\=/,/\=>/,/!(?=\w)/,/(?<=\s)(\?|:)(?=\s)/,r,/(?<!\?)\?(?!\?|\.|\[)/,/%[^%]|\*[^\/]|\/[^\/\*]|(?<!\-)\-(?!\-)|(?<!\+)\+(?!\+)/,/(?<!\=|!)\=(?!\=|>)/],T=A.concat(...h),y={
$pattern:t.concat(/(?<!\.)\b/,a,/(?!\s*\()/),keyword:[...b,...d,...E],
"variable.language":u,type:m,literal:S
},R=[/--/,/\+\+/,/\&\&|\|\|/,/\*\=|\/\=|\%\=|\+\=|-\=/,/\&\=|\^\=|<<\=|>>\=|>>>\=|\|\=/,/\&|~|\^|\|/,/<<|>>/,/<\=|>\=|\s(<|>)\s/,/\=\=|!\=/,/\=>/,/!(?=\w)/,/(?<=\s)(\?|:)(?=\s)/,i,/(?<!\?)\?(?!\?|\.|\[)/,/%[^%]|\*[^\/]|\/[^\/\*]|(?<!\-)\-(?!\-)|(?<!\+)\+(?!\+)/,/(?<!\=|!)\=(?!\=|>)/],T=A.concat(...h),y={
$pattern:t.concat(/(?<!\.)\b/,a,/\b/),keyword:[...b,...d,...E],type:m,literal:S
},L=[...S,...b,...d,...A,...h,...v,...u,...E],N={
match:t.concat(/\b/,t.either(...u),/\b/),scope:"variable.language",relevance:0
},O=[{match:[t.concat(/\b/,t.either(...v)),/\./,a,/\b\s*(?![\.\(])/],scope:{
1:"built_in",2:"punctuation",3:"variable"},relevance:0},{
match:[t.concat(/\b/,t.either(...h)),/\./,a,/\b\s*(?![\.\(])/],scope:{
1:"built_in",2:"punctuation",3:"type"},relevance:0},{
match:[t.concat(/\b/,t.either(...A)),/\./,t.concat(c,/\b(?=\.)/)],scope:{
1:"built_in",2:"punctuation",3:"type"}},{
match:[t.concat(/\b/,t.either(...A)),/\./,c,/\b(?=\.)/],scope:{1:"built_in",
2:"punctuation",3:"type"}},{
match:[t.concat(/\b/,t.either(...A,...h)),/\./,c,/\b(?!\.)/],scope:{
1:"built_in",2:"punctuation",3:"keyword"}},{
match:[/\bTrigger\b/,/\./,/(isExecuting|isInsert|isUpdate|isDelete|isBefore|isAfter|isUndelete|new|newMap|old|oldMap|size|operationType)\b(?!\.)/],
Expand All @@ -1246,8 +1246,9 @@ scope:"string",relevance:0,contains:[{match:/\\'/,scope:"literal",relevance:0}]
relevance:0,contains:[{begin:/\w+@/,relevance:0},{
match:[/@(?:exception|throws)/,s,a],scope:{1:"doctag",3:"title.class"},
relevance:0},{begin:"@[A-Za-z_-]+",scope:"doctag",relevance:0},{
match:[/(?<=@param)\s+/,a],scope:{2:"variable"},relevance:0},{begin:"`",end:"`",
scope:"string",contains:[e.BACKSLASH_ESCAPE],relevance:0}]}),D],_={
match:[/(?<=@param)\s+/,a],scope:{2:"variable"},relevance:0},{excludeBegin:!0,
excludeEnd:!0,contains:[e.BACKSLASH_ESCAPE],relevance:0,variants:[{begin:"`",
end:"`",scope:"subst"},{begin:/'/,end:/'/,scope:"string"}]}]}),D],_={
match:t.either(...R),scope:"operator",relevance:0},U={match:/(?<!\.)\bId\b/,
scope:"type",relevance:8},f=[{begin:/\b(list|set|map)(?=\s*<)/,
beginScope:"type",end:/\>+/,endScope:"punctuation",contains:[{match:/\<|\,/,
Expand All @@ -1263,14 +1264,14 @@ relevance:0},F={match:[/(?<!\.)/,c,/\s*(?=\=[^\>])/],scope:{2:"variable"},
relevance:0},P={match:[/(?<=\=\s*\()/,a,"(?=\\)\\s*"+a+")"],scope:{2:"type"},
relevance:0},Y={match:[/\bnew\s+/,a,o],scope:{2:"type"},relevance:0};let W={
scope:"params_call",begin:/\(/,beginScope:"punctuation",end:/\)/,
endScope:"punctuation",relevance:0,keywords:y,contains:[]};const H=[{
endScope:"punctuation",relevance:0,keywords:y,contains:[]};const x=[{
match:[/(?<=\.)/,a,o],scope:{2:"title.function.invoke"},relevance:1,
contains:[...i],starts:W},{match:[/^\s*/,l(...b),a,o],scope:{
contains:[...r],starts:W},{match:[/^\s*/,l(...b),a,o],scope:{
3:"title.function.invoke"},relevance:1,starts:W}]
;W.contains=[C,Y,I,_,f,O,p,U,H,{keywords:{KEYWORDS:y},
;W.contains=[C,Y,I,_,f,O,p,U,x,{keywords:{KEYWORDS:y},
match:t.concat(/(?<=\s|\(|\,)/,l(...S),a,/\b/,/(?!\.)/),scope:"variable",
relevance:0},{match:/\(|\,|\./,scope:"punctuation",relevance:0},{match:a,
scope:"variable"}];const x={scope:"params",end:/\)/,endScope:"punctuation",
scope:"variable"}];const H={scope:"params",end:/\)/,endScope:"punctuation",
relevance:1,keywords:y,contains:[p,C,I,f,...O,{match:/\,|\(/,scope:"punctuation"
},U,{match:[/(?<=\(|\,)\s*/,a,/(?=\s)/],scope:{2:"type"}},{
match:[s,a,/\s*(?=[,)])/],scope:{2:"variable"}}]},B={
Expand All @@ -1294,16 +1295,16 @@ scope:"punctuation"},O],relevance:0}]},{begin:[/\benum\s+/,a,/\s*\{/],
beginScope:{2:"type",3:"punctuation"},end:/\}/,endScope:"punctuation",
relevance:0,contains:[I,g,{match:t.concat(c),scope:"variable.constant"}]},{
match:[/(public|private|protected)\s+/,a,o],scope:{1:"keyword",
2:"title.function"},starts:x,relevance:1},{
2:"title.function"},starts:H,relevance:1},{
match:[/(?<!new)(?<!return)(?<=\<|\>|\w)\s+/,a,o],scope:{2:"title.function"},
relevance:1,starts:x}],[{match:/as\s+(user|system)\b/,scope:"keyword"}],k,{
relevance:1,starts:H}],[{match:/as\s+(user|system)\b/,scope:"keyword"}],k,{
match:[/\bfor\b\s*/,/\(/,a,s,a,/\s*/,/:/],scope:{3:"type",5:"variable",
7:"operator"}},H,Y,N,O,U,{begin:[/\[/,/\s*(?=(SELECT|FIND)\b)/],end:/\]/,
7:"operator"}},x,Y,N,O,U,{begin:[/\[/,/\s*(?=(SELECT|FIND)\b)/],end:/\]/,
beginScope:{1:"punctuation"},endScope:"punctuation",scope:"soql",relevance:10,
endsWithParent:!0,keywords:{literal:y.literal,built_in:T},contains:[p,_,C,g,{
match:/\(|\)/,scope:"punctuation",relevance:0},...i,{begin:[/\bFROM\b/,s],
match:/\(|\)/,scope:"punctuation",relevance:0},...r,{begin:[/\bFROM\b/,s],
beginScope:{1:"keyword"},end:/(?=\bWHERE\b|\]|\s|\))/,contains:[{match:a,
scope:"type"},...i]},{
scope:"type"},...r]},{
match:t.concat(/\b/,t.either("CALENDAR_MONTH","CALENDAR_QUARTER","CALENDAR_YEAR","DAY_IN_MONTH","DAY_IN_WEEK","DAY_IN_YEAR","DAY_ONLY","FISCAL_MONTH","FISCAL_QUARTER","FISCAL_YEAR","HOUR_IN_DAY","WEEK_IN_MONTH","WEEK_IN_YEAR","AVG","convertCurrency","convertTimezone","COUNT_DISTINCT","COUNT","DISTANCE","EXCLUDES","FIELDS","FORMAT","GEOLOCATION","GROUPING","ROLLUP","CUBE","INCLUDES","MAX","MIN","SUM","toLabel"),/\b/),
scope:"title.function"},{match:/\b(GROUP|ORDER)\s+BY\b/,scope:"title.function"
},{match:/\b(TODAY|TOMORROW|YESTERDAY)\b/,scope:"keyword"},{
Expand All @@ -1315,6 +1316,6 @@ match:t.concat(/\b/,t.either(...y.keyword,"ABOVE_OR_BELOW","ABOVE","ACTIVE","ADV
scope:"keyword"},{match:[/(?<=:)/,/\s*/,c,/(?!\()/],scope:{3:"variable"},
relevance:0},{match:[/(?<=:|\.)/,a,/(?=\s*\()/],scope:{2:"title.function.invoke"
},relevance:0},{match:/:/,scope:"operator",relevance:0}],illegal:"::"
},B,F,_,w,i,{match:t.concat("(?<=this.)",a,"(?!\\()"),scope:"variable"},{
},B,F,_,w,r,{match:t.concat("(?<=this.\b)",a,"(?!\\()"),scope:"variable"},{
match:[t.concat(/\b/,l(...L)),a,s,/(?=\{)/],scope:{2:"property"},relevance:0}]}}
})();hljs.registerLanguage("apex",e)})();
4 changes: 2 additions & 2 deletions doc-assets/main.html
Original file line number Diff line number Diff line change
Expand Up @@ -32,10 +32,10 @@ <h2>Installation (via VCS)</h2>
</ul>
<h2>Package Installation</h2>
<a href="https://login.salesforce.com/packaging/installPackage.apexp?p0=04tQm0000009IIfIAM">
<img alt="Deploy to Salesforce" src="./media/deploy-package-to-prod.png" />
<img alt="Deploy to Salesforce" src="./assets/deploy-package-to-prod.png" />
</a>
<a href="https://test.salesforce.com/packaging/installPackage.apexp?p0=04tQm0000009IIfIAM">
<img alt="Deploy to Salesforce Sandbox" src="./media/deploy-package-to-sandbox.png" />
<img alt="Deploy to Salesforce Sandbox" src="./assets/deploy-package-to-sandbox.png" />
</a>

<br />
Expand Down
1 change: 1 addition & 0 deletions doc-assets/setupApexDox.sh
Original file line number Diff line number Diff line change
Expand Up @@ -17,5 +17,6 @@ printf '<link href="assets/styling.css" rel="stylesheet" />' > "doc-assets/chang
#echo >> "doc-assets/changelog.html"
npx marked -i CHANGELOG.md --gfm >> "doc-assets/changelog.html"
sed -i "" "s|CHANGELOG.md|changelog.html|" "doc-assets/main.html"
sed -i "" "s|media/|assets/|" "doc-assets/main.html"

npm run updateHighlight
Binary file added docs/assets/deploy-package-to-prod.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/assets/deploy-package-to-sandbox.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading

0 comments on commit d3717fc

Please sign in to comment.