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.

Sign up for GitHub

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

Jump to bottom

Markdown Conversion for the rest of documentation files #400

Merged
merged 80 commits into from
Jan 22, 2025
Merged

Markdown Conversion for the rest of documentation files #400

merged 80 commits into from
Jan 22, 2025

Conversation

danlwill
Copy link
Contributor

@danlwill danlwill commented Jan 14, 2025 •
edited by landinjm
Loading

Changes:

  • \grad converted to \nabla, \Bkappa to \kappa
  • \underbrace removed and equations separated out
  • converted tables to markdown syntax
  • removed \ forced indent because of incapability, instead just created a new {align} space
  • Changed title headers and sub headings to markdown syntax
  • Removed LaTeX bibliography space and replaced with manual writing
  • Changed links to link syntax
  • Manually cited equations and sections when they are referenced (markdown does not support equation labels and citation)
  • Changed bold and italics to markdown syntax
  • Wrapped all equation spaces with $$

@landinjm
Copy link
Contributor

Closes #189

@danlwill danlwill marked this pull request as ready for review January 17, 2025 22:50
@danlwill
Copy link
Contributor Author

@landinjm everything should be done

danlwill added 25 commits January 22, 2025 12:55
@danlwill @landinjm
Create MgNd_precipitate_single_Bppp.md
7270f90
@danlwill @landinjm
Update and rename MgNd_precipitate_single_Bppp.md to precipitateEvolu…
424e37a 
…tion_KKS.md
@danlwill @landinjm
Edit main title for consistency
1e093f1
@danlwill @landinjm
Update CHAC_anisotropy.md
7690076
@danlwill @landinjm
Update formulation_coupledCHAC.md
c36aa6e
@danlwill @landinjm
Create allenCahn_conserved.md
7c6d2d2
@danlwill @landinjm
Update allenCahn_conserved.md
91f32e0
@danlwill @landinjm
Delete applications/allenCahn_conserved/tex_files directory
5fb2a3d
@danlwill @landinjm
Delete applications/allenCahn_conserved/allenCahn_conserved.pdf
e83c480
@danlwill @landinjm
Create and prototype md file for alloySolidification
d97532c
@danlwill @landinjm
Create alloySolidification_uniform.md prototype
5dafd42
@danlwill @landinjm
Create anisotropyFacet.md prototype
3252148
@danlwill @landinjm
Create cahnHilliard.md prototype
a19cf00
@danlwill @landinjm
Create corrosion.md prototype
87a4c84
@danlwill @landinjm
Create corrosion_microgalvanic.md prototype
2a66108
@danlwill @landinjm
Create formulation_coupledCHAC.md prototype
8f67dc7
@danlwill @landinjm
Create dendriticSolidification.md prototype
1db2888
@danlwill @landinjm
Create eshelbyInclusion.md prototype
075622b
@danlwill @landinjm
Create formulation_fickianFlux.md prototype
c6f0767
@danlwill @landinjm
Create grainGrowth.md prototype
8f17ab6
@danlwill @landinjm
Create mechanics.md prototype
17aa43d
@danlwill @landinjm
Create KKS_nucleation.md prototype
c5cb8ca
@danlwill @landinjm
Create formulation_precipitateEvolution.md prototype
cda0cfd
@danlwill @landinjm
Small fix
15e6cfb
@danlwill @landinjm
Finish alloySolidification.md
00e91c8
danlwill added 25 commits January 22, 2025 12:55
@danlwill @landinjm
Add files via upload
2d4e5b9
@danlwill @landinjm
Delete applications/grainGrowth_dream3d/grainGrowth.pdf
8578971
@danlwill @landinjm
Add files via upload
cf22f16
@danlwill @landinjm
Delete applications/grainGrowth_dream3d/tex_files directory
8bbdd30
@danlwill @landinjm
Finish mechanics.md
368e312
@danlwill @landinjm
Delete applications/mechanics/tex_files directory
fb9dd79
@danlwill @landinjm
Delete applications/mechanics/mechanics.pdf
29ae298
@danlwill @landinjm
Add files via upload
2b16aa7
@danlwill @landinjm
Delete applications/spinodalDecomposition/formulation_cahnHillard.pdf
f4a6fb1
@danlwill @landinjm
Finish dendriticSolidification.md
20ccc6c
@danlwill @landinjm
Delete applications/dendriticSolidification/tex_files directory
c561e8c
@danlwill @landinjm
Delete applications/dendriticSolidification/dendriticSolidification.pdf
3fdebc6
@danlwill @landinjm
Finish eshelbyInclusion.md
91e019b
@danlwill @landinjm
Delete applications/eshelbyInclusion/tex_files directory
0d0c61d
@danlwill @landinjm
Delete applications/eshelbyInclusion/eshelbyInclusion.pdf
d70aa9d
@danlwill @landinjm
Finish KKS_nucleation.md
eace5b1
@danlwill @landinjm
Delete applications/nucleationModel/tex_files directory
28fa658
@danlwill @landinjm
Delete applications/nucleationModel/KKS_nucleation.pdf
f205e4e
@danlwill @landinjm
Add files via upload
dc1924b
@danlwill @landinjm
Delete applications/nucleationModel_preferential/tex_files directory
de832fe
@danlwill @landinjm
Delete applications/nucleationModel_preferential/KKS_nucleation.pdf
caccba5
@danlwill @landinjm
Finish formulation_precipitateEvolution.md
0c1f9e2
@danlwill @landinjm
Delete applications/precipitateEvolution/tex_files directory
7a5a5fa
@danlwill @landinjm
Delete applications/precipitateEvolution/formulation_precipitateEvolu…
0500188 
…tion.pdf
@danlwill @landinjm
Add files via upload
f5f2503
@landinjm landinjm force-pushed the danlwill-full-markdown-conversion branch from 2bf33f8 to f5f2503 Compare January 22, 2025 17:59
@landinjm landinjm merged commit 15181c3 into prisms-center:devel Jan 22, 2025
1 check passed
@danlwill danlwill deleted the danlwill-full-markdown-conversion branch January 22, 2025 19:32
landinjm added a commit that referenced this pull request Jan 27, 2025
@danlwill @landinjm
Markdown Conversion for the rest of documentation files (#400)
3a4aedb 
* Create MgNd_precipitate_single_Bppp.md

* Update and rename MgNd_precipitate_single_Bppp.md to precipitateEvolution_KKS.md

* Edit main title for consistency

* Update CHAC_anisotropy.md

* Update formulation_coupledCHAC.md

* Create allenCahn_conserved.md

* Update allenCahn_conserved.md

* Delete applications/allenCahn_conserved/tex_files directory

* Delete applications/allenCahn_conserved/allenCahn_conserved.pdf

* Create and prototype md file for alloySolidification

* Create alloySolidification_uniform.md prototype

* Create anisotropyFacet.md prototype

* Create cahnHilliard.md prototype

* Create corrosion.md prototype

* Create corrosion_microgalvanic.md prototype

* Create formulation_coupledCHAC.md prototype

* Create dendriticSolidification.md prototype

* Create eshelbyInclusion.md prototype

* Create formulation_fickianFlux.md prototype

* Create grainGrowth.md prototype

* Create mechanics.md prototype

* Create KKS_nucleation.md prototype

* Create formulation_precipitateEvolution.md prototype

* Small fix

* Finish alloySolidification.md

* Delete applications/alloySolidification/tex_files directory

* Delete applications/alloySolidification/alloySolidification.pdf

* Finish alloySolidification_uniform.md

* Delete applications/alloySolidification_uniform/tex_files directory

* Delete applications/alloySolidification_uniform/alloySolidification_uniform.pdf

* Finish anisotropyFacet.md

* Delete applications/anisotropyFacet/tex_files directory

* Delete applications/anisotropyFacet/anisotropyFacet.pdf

* Finish cahnHilliard.md

* Delete applications/cahnHilliard/tex_files directory

* Delete applications/cahnHilliard/formulation_cahnHillard.pdf

* Update corrosion.md

* Finish corrosion.md

* Delete applications/corrosion/tex_files directory

* Delete applications/corrosion/corrosion.pdf

* Finish corrosion_microgalvanic.md

* Delete applications/corrosion_microgalvanic/tex_files directory

* Delete applications/corrosion_microgalvanic/corrosion_microgalvanic.pdf

* Finish formulation_coupledCHAC.md

* Delete applications/coupledCahnHilliardAllenCahn/tex_files directory

* Delete applications/coupledCahnHilliardAllenCahn/formulation_coupledCHAC.pdf

* Update dendriticSolidification.md

* Update eshelbyInclusion.md

* Finish formulation_fickianFlux.md

* Delete applications/fickianDiffusion/tex_files directory

* Delete applications/fickianDiffusion/formulation_fickianFlux.pdf

* Finish grainGrowth.md

* Delete applications/grainGrowth/tex_files directory

* Delete applications/grainGrowth/grainGrowth.pdf

* Add files via upload

* Delete applications/grainGrowth_dream3d/grainGrowth.pdf

* Add files via upload

* Delete applications/grainGrowth_dream3d/tex_files directory

* Finish mechanics.md

* Delete applications/mechanics/tex_files directory

* Delete applications/mechanics/mechanics.pdf

* Add files via upload

* Delete applications/spinodalDecomposition/formulation_cahnHillard.pdf

* Finish dendriticSolidification.md

* Delete applications/dendriticSolidification/tex_files directory

* Delete applications/dendriticSolidification/dendriticSolidification.pdf

* Finish eshelbyInclusion.md

* Delete applications/eshelbyInclusion/tex_files directory

* Delete applications/eshelbyInclusion/eshelbyInclusion.pdf

* Finish KKS_nucleation.md

* Delete applications/nucleationModel/tex_files directory

* Delete applications/nucleationModel/KKS_nucleation.pdf

* Add files via upload

* Delete applications/nucleationModel_preferential/tex_files directory

* Delete applications/nucleationModel_preferential/KKS_nucleation.pdf

* Finish formulation_precipitateEvolution.md

* Delete applications/precipitateEvolution/tex_files directory

* Delete applications/precipitateEvolution/formulation_precipitateEvolution.pdf

* Add files via upload

* Automatics tests don't need model descriptions

---------

Co-authored-by: Jason Landini <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@landinjm landinjm landinjm approved these changes

Assignees
No one assigned
Labels
Documentation: General
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
2 participants
@danlwill @landinjm